text-marker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ecb01a506370f70d3b8215401bbe9be1611e6906
+  data.tar.gz: e1f6be7eeef9bc0199ac419a6deb97e74cf6d86a
+SHA512:
+  metadata.gz: fadc9f88a55aa568d5f8212255bbc2d1a9327a314ff96d3284063d95f0785b0df57eaacc9faab810f7cbf2786dc2977e38f672503e1dcfdac2db5ce8eeecc11a
+  data.tar.gz: 0590e42d4d9b8feee0aa18db0b8cd72e5bee5ed15fb1a02d69a5ae0f11e35da5df6ccf924363a7cd75f7cd76606cc5676a01834fbc897ee2dee289d8ff840939

data/.gitignore

@@ -0,0 +1,34 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in text-maker.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 geisonfgf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

data/README.md

@@ -0,0 +1,73 @@
+TextMarker
+===========
+
+Gem that mark string in a text. It is possible mark the text with html tags.
+
+Installation
+============
+
+Gemfile
+-------
+
+1) add in your Gemfile
+
+    gem 'text-marker'
+
+2) run this line in your prompt
+
+    $ bundle install text-marker
+
+
+RubyGems
+-------
+
+    $ gem install text-marker
+
+Usage
+=====
+
+```ruby
+require 'text-marker'
+
+snippet_to_be_marked = "text"
+text = "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+
+text_marked = TextMarker::Marker.new(text).mark_first_ocurrence_of(snippet_to_be_marked)
+
+tm = TextMarker.Marker.new "Text"
+tm_tag1 = TextMarker::Tag.new :tag, :background_color, :text_color
+
+text_with_all_ocurrence_of_snipped_marked = tm.mark_all_ocurrence_of(
+  "snippet-to-be-marked", tm_tag1)
+
+text_with_all_ocurrences_of_snipped_marked = tm.mark_all_ocurrence_of(
+  "snippet-to-be-marked", TextMarker::Tag.new :span)
+
+text_with_first_ocurrence_of_snipped_marked = tm.mark_first_ocurrence_of(
+  "snippet-to-be-marked", TextMarker::Tag.new :span, :yellow)
+```
+
+Author
+======
+
+#### Created and maintained by
+Geison Felipe Goes Flores
+
+geisonfgf@gmail.com
+
+@geisonfgfg
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/text-marker/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+License
+=======
+
+TextMarker is licensed under the MIT license.
+
+See LICENSE for the full license text.

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color', '--format', 'nested']
+end
+
+task :default => :spec

data/lib/textmarker.rb

@@ -0,0 +1,25 @@
+require "textmarker/version"
+
+module TextMarker
+  class Marker
+    attr_accessor :text
+
+    def initialize(text="")
+      @text = text
+    end
+
+    def mark_all_ocurrence_of(snippet_to_be_marked, tag=Tag.new)
+      @text.gsub(snippet_to_be_marked, build_marked_snippet(snippet_to_be_marked, tag))
+    end
+
+    def mark_first_ocurrence_of(snippet_to_be_marked, tag=Tag.new)
+      @text.sub(snippet_to_be_marked, build_marked_snippet(snippet_to_be_marked, tag))
+    end
+
+    private
+
+      def build_marked_snippet(snippet_to_be_marked, tag)
+        tag.open_tag + snippet_to_be_marked + tag.close_tag
+      end
+  end
+end

data/lib/textmarker/tag.rb

@@ -0,0 +1,31 @@
+require "textmarker/version"
+
+module TextMarker
+  class Tag
+    attr_accessor :tag, :background_color, :text_color
+    attr_reader :open_tag, :close_tag
+
+    def initialize(tag=:span, background_color=:yellow, text_color=:black)
+      @tag = tag
+      @background_color = background_color
+      @text_color = text_color
+
+      @open_tag = generate_open_tag
+      @close_tag = generate_close_tag
+    end
+
+    def to_s
+      generate_open_tag + generate_close_tag
+    end
+
+    private
+
+      def generate_open_tag
+        "<#{@tag} style='background_color: #{@background_color}; color: #{@text_color};'>"
+      end
+
+      def generate_close_tag
+        "</#{@tag}>"
+      end
+  end
+end

data/lib/textmarker/version.rb

@@ -0,0 +1,3 @@
+module TextMarker
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'simplecov'
+SimpleCov.start
+
+require 'textmarker'
+require 'textmarker/tag'

data/spec/tag_spec.rb

@@ -0,0 +1,28 @@
+require 'spec_helper'
+
+describe "TextMarker::Tag.new" do
+  before(:each) do
+    @instance_default = TextMarker::Tag.new
+    @instance = TextMarker::Tag.new :h1, :black, :white
+  end
+
+  it 'Shoud create a Default Tag object' do
+    expect(@instance_default).to be_a TextMarker::Tag
+    expect(@instance_default.tag).to eq :span
+    expect(@instance_default.open_tag).to eq "<span style='background_color: yellow; color: black;'>"
+    expect(@instance_default.close_tag).to eq "</span>"
+    expect(@instance_default.background_color).to eq :yellow
+    expect(@instance_default.text_color).to eq :black
+    expect(@instance_default.to_s).to eq "<span style='background_color: yellow; color: black;'></span>"
+  end
+
+  it 'Shoud create a Tag object' do
+    expect(@instance).to be_a TextMarker::Tag
+    expect(@instance.tag).to eq :h1
+    expect(@instance.open_tag).to eq "<h1 style='background_color: black; color: white;'>"
+    expect(@instance.close_tag).to eq "</h1>"
+    expect(@instance.background_color).to eq :black
+    expect(@instance.text_color).to eq :white
+    expect(@instance.to_s).to eq "<h1 style='background_color: black; color: white;'></h1>"
+  end
+end

data/spec/textmarker_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe "TextMarker::Marker" do
+  before(:each) do
+    @instance_tag = TextMarker::Tag.new :h1, :black, :white
+    @instance_default = TextMarker::Marker.new
+    @instance_with_text = TextMarker::Marker.new "Some text to be marked."
+    @instance_with_long_text = TextMarker::Marker.new "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+  end
+
+  it 'Shoud create a Marker object with no text' do
+    expect(@instance_default).to be_a TextMarker::Marker
+    expect(@instance_default.text).to eq ""
+  end
+
+  it 'Shoud create a Marker object with text' do
+    expect(@instance_with_text).to be_a TextMarker::Marker
+    expect(@instance_with_text.text).to eq "Some text to be marked."
+  end
+
+  it 'Shoud return the text passed to Marker with the first snippet of desired text marked, passing a default Tag' do
+    expect(@instance_with_long_text).to be_a TextMarker::Marker
+    expect(@instance_with_long_text.text).to eq "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(@instance_with_long_text.mark_first_ocurrence_of("text")).to eq "Some <span style='background_color: yellow; color: black;'>text</span> to be marked. After used TextMaker in this text it will return this text with desired text marked."
+  end
+
+  it 'Shoud return the text passed to Marker with the first snippet of desired text marked, passing a custom Tag' do
+    expect(@instance_with_long_text).to be_a TextMarker::Marker
+    expect(@instance_with_long_text.text).to eq "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(@instance_with_long_text.mark_first_ocurrence_of("text", @instance_tag)).to eq "Some <h1 style='background_color: black; color: white;'>text</h1> to be marked. After used TextMaker in this text it will return this text with desired text marked."
+  end
+
+  it 'Shoud return the text passed to Marker with the snippets of desired text marked, passing a default Tag' do
+    expect(@instance_with_long_text).to be_a TextMarker::Marker
+    expect(@instance_with_long_text.text).to eq "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(@instance_with_long_text.mark_all_ocurrence_of("text")).to eq "Some <span style='background_color: yellow; color: black;'>text</span> to be marked. After used TextMaker in this <span style='background_color: yellow; color: black;'>text</span> it will return this <span style='background_color: yellow; color: black;'>text</span> with desired <span style='background_color: yellow; color: black;'>text</span> marked."
+  end
+
+  it 'Shoud return the text passed to Marker with the snippets of desired text marked, passing a custom Tag' do
+    expect(@instance_with_long_text).to be_a TextMarker::Marker
+    expect(@instance_with_long_text.text).to eq "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(@instance_with_long_text.mark_all_ocurrence_of("text", @instance_tag)).to eq "Some <h1 style='background_color: black; color: white;'>text</h1> to be marked. After used TextMaker in this <h1 style='background_color: black; color: white;'>text</h1> it will return this <h1 style='background_color: black; color: white;'>text</h1> with desired <h1 style='background_color: black; color: white;'>text</h1> marked."
+  end
+
+  it 'Shoud return the exact same text passed to Marker, passing a default Tag and a snippet that does not exist in the text' do
+    snippet_not_found_in_text = "snippet_not_found_in_text"
+    text = "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(@instance_with_long_text).to be_a TextMarker::Marker
+    expect(@instance_with_long_text.text).to eq text
+    expect(@instance_with_long_text.mark_first_ocurrence_of(snippet_not_found_in_text)).to eq text
+    expect(@instance_with_long_text.mark_all_ocurrence_of(snippet_not_found_in_text)).to eq text
+  end
+
+  it 'Shoud return the text passed to Marker with the first snippet of desired text marked, passing a default Tag and using Marker in one line' do
+    text = "Some text to be marked. After used TextMaker in this text it will return this text with desired text marked."
+    expect(TextMarker::Marker.new(text).mark_first_ocurrence_of("text")).to eq "Some <span style='background_color: yellow; color: black;'>text</span> to be marked. After used TextMaker in this text it will return this text with desired text marked."
+  end
+end

data/text-maker.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "textmarker/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "text-marker"
+  spec.version       = TextMarker::VERSION
+  spec.authors       = ["Geison Goes"]
+  spec.email         = ["geisonfgf@gmail.com"]
+  spec.summary       = %q{Gem that mark string in a text.}
+  spec.description   = %q{Gem that mark string in a text. It is possible mark the text with html tags.}
+  spec.homepage      = "https://github.com/geisonfgf/text-marker"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: text-marker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Geison Goes
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Gem that mark string in a text. It is possible mark the text with html
+  tags.
+email:
+- geisonfgf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .DS_Store
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/textmarker.rb
+- lib/textmarker/tag.rb
+- lib/textmarker/version.rb
+- spec/spec_helper.rb
+- spec/tag_spec.rb
+- spec/textmarker_spec.rb
+- text-maker.gemspec
+homepage: https://github.com/geisonfgf/text-marker
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Gem that mark string in a text.
+test_files:
+- spec/spec_helper.rb
+- spec/tag_spec.rb
+- spec/textmarker_spec.rb