Giter VIP home page Giter VIP logo

gem-code-sample's Introduction

KeywordReplacer Build Status

This gem allows you to replace specified keywords with the links in the text.

Problem description

Let's assume that there is a text(rich text or regular string) and you want to add links to specific words(links to store, faq, forum, etc.).

It'd be annoying to edit text each time when for example link is changed or you need another keyword. It's more convenient to have a list of keywords that should be replaced with a link. That is exactly what this gem does.

Installation

Add this line to your application's Gemfile:

gem 'keyword_replacer'

And then execute:

$ bundle

Or install it yourself as:

$ gem install keyword_replacer

Usage

class Post < ActiveRecord::Base
  replaces_links method_name: :transformed_text, source: :text, custom_class: 'custom',
                 max_matches: -> { 10 },
                 keywords: -> { ['keyword_1'] },
                 keywords_with_links: -> { { 'keyword_1' => 'https://google.com' } }
end

Useful info

Architecture of implemetation

There is a super handy pattern called Module builder It has the following advantages:

  • modules are just like any other objects—they can be created on the fly
  • assigned to variables
  • dynamically modified, as well as passed to or returned from methods

Example:

  class SomeModule < Module
    def initialize(method_names)
      method_names.each do |name|
        define_method(name) do
          puts "#It's #{name} method"
        end
      end
    end
  end

  class Post
    include SomeModule.new(%i[foo bar])
  end

License

The gem is available as open source under the terms of the MIT License.

gem-code-sample's People

Watchers

Alex avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.