range_sentence_parser 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--colour

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Gabriel Sobrinho
+
+MIT License
+
+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,58 @@
+# RangeSentenceParser
+
+Parser for range sentences like '1990; 1995-2000; 2005'.
+
+I use it primarily for reports but can be used for anything else.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'range_sentence_parser'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install range_sentence_parser
+
+## Usage
+
+Stand-alone:
+
+    RangeSentenceParser.parse!('1990; 1995-2000; 2005')
+    # => [1990, 1995..2000, 2005]
+
+    RangeSentenceParser.valid?('1990; 1995-2000; 2005')
+    # => true
+
+    RangeSentenceParser.invalid?('1990; 1995-2000; 2005')
+    # => false
+
+Integrated with ActiveRecord:
+
+    class AccountingReport < ActiveRecord::Base
+      validates :year_sentence, :range_sentence => true
+
+      def years
+        RangeSentenceParser.parse!(year_sentence)
+      end
+    end
+
+    accounting_report = AccountingReport.new(:year_sentence => '1990; 1995-2000; 2005')
+
+    accounting_report.valid?
+    # => true
+
+    accounting_report.years
+    # => [1990, 1995..2000, 2005]
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/range_sentence_parser.rb

@@ -0,0 +1,65 @@
+class RangeSentenceParser
+  # Parse the sentence and return a collection of numbers and/or ranges
+  #
+  # Usage:
+  #
+  #   RangeSentenceParser.parse!('')                      # => []
+  #   RangeSentenceParser.parse!('1990')                  # => [1990]
+  #   RangeSentenceParser.parse!('1990; 1995')            # => [1990, 1995]
+  #   RangeSentenceParser.parse!('1990-1995')             # => [1990..1995]
+  #   RangeSentenceParser.parse!('1990; 1995-2000; 2005') # => [1990, 1995..2000, 2005]
+  def self.parse!(sentence)
+    range_sentence_parser = self.new(sentence)
+    range_sentence_parser.parse!
+  end
+
+  # Validate the sentence and return true or false
+  #
+  # Usage:
+  #
+  #   RangeSentenceParser.valid?('1990; 1995-2000; 2005') # => true
+  #   RangeSentenceParser.valid?('1990, 1995-2000, 2005') # => false
+  def self.valid?(sentence)
+    range_sentence_parser = self.new(sentence)
+    range_sentence_parser.valid?
+  end
+
+  # Performs the opposite of valid?
+  #
+  # Usage:
+  #
+  #   RangeSentenceParser.invalid?('1990; 1995-2000; 2005') # => false
+  #   RangeSentenceParser.invalid?('1990, 1995-2000, 2005') # => true
+  def self.invalid?(sentence)
+    range_sentence_parser = self.new(sentence)
+    range_sentence_parser.invalid?
+  end
+
+  def initialize(sentence)
+    self.sentence = sentence
+  end
+
+  def parse!
+    raise InvalidSentenceError if invalid?
+
+    sentence.split(';').map do |number|
+      if number =~ /(\d+)-(\d+)/
+        Range.new($1.to_i, $2.to_i)
+      else
+        number.to_i
+      end
+    end
+  end
+
+  def valid?
+    sentence.empty? || sentence =~ /^\d+(-\d+)?(\s*;\s*\d+(-\d+)?)*;?$/
+  end
+
+  def invalid?
+    !valid?
+  end
+
+  private
+
+  attr_accessor :sentence
+end

data/lib/range_sentence_parser/invalid_sentence_error.rb

@@ -0,0 +1,4 @@
+class RangeSentenceParser
+  class InvalidSentenceError < ArgumentError
+  end
+end

data/lib/range_sentence_parser/version.rb

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

data/lib/range_sentence_validator.rb

@@ -0,0 +1,14 @@
+class RangeSentenceValidator < ActiveModel::EachValidator
+  # Validates whether the value of the specified attribute is of the correct form for RangeSentenceParser.
+  #
+  # Usage:
+  #
+  #   class AccountingReport
+  #     include ActiveModel::Validations
+  #
+  #     validates :year_sentence, :range_sentence => true
+  #   end
+  def validate_each(record, attribute, value)
+    record.errors.add(attribute) if RangeSentenceParser.invalid?(value)
+  end
+end

data/range_sentence_parser.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/range_sentence_parser/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Gabriel Sobrinho"]
+  gem.email         = ["gabriel.sobrinho@gmail.com"]
+  gem.description   = %q{Parser for range sentences like '1990; 1995-2000; 2005'}
+  gem.summary       = %q{Parser for range sentences like '1990; 1995-2000; 2005'}
+  gem.homepage      = "https://github.com/sobrinho/range_sentence_parser"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "range_sentence_parser"
+  gem.require_paths = ["lib"]
+  gem.version       = RangeSentenceParser::VERSION
+
+  gem.add_development_dependency 'activemodel', '>= 3.0'
+  gem.add_development_dependency 'rspec', '>= 2.9'
+end

data/spec/range_sentence_parser_spec.rb

@@ -0,0 +1,66 @@
+require 'spec_helper'
+
+describe RangeSentenceParser do
+  context '.parse!' do
+    it 'parses empty string' do
+      ''.should be_parsed_to []
+    end
+
+    it 'parses one number' do
+      '1990'.should be_parsed_to [1990]
+    end
+
+    it 'parses many numbers' do
+      '1990; 1995'.should be_parsed_to [1990, 1995]
+    end
+
+    it 'parses one range' do
+      '1990-1995'.should be_parsed_to [1990..1995]
+    end
+
+    it 'parses many ranges' do
+      '1990-1995; 2000-2005'.should be_parsed_to [1990..1995, 2000..2005]
+    end
+
+    it 'parses one number and one range' do
+      '1990; 1995-2000'.should be_parsed_to [1990, 1995..2000]
+    end
+
+    it 'parses many numbers and many ranges' do
+      '1990; 1995-2000; 2005; 2010-2015'.should be_parsed_to [1990, 1995..2000, 2005, 2010..2015]
+    end
+
+    it 'do not cares about inner spaces' do
+      '1990;  1995-2000;  2005;  2010-2015'.should be_parsed_to [1990, 1995..2000, 2005, 2010..2015]
+      '1990;1995-2000;2005;2010-2015'.should be_parsed_to [1990, 1995..2000, 2005, 2010..2015]
+    end
+
+    it 'do not cares about last semicolon' do
+      '1990;'.should be_parsed_to [1990]
+      '1990; 1995-2000; 2005; 2010-2015;'.should be_parsed_to [1990, 1995..2000, 2005, 2010..2015]
+    end
+
+    it 'raises an error for invalid sentences' do
+      expect { described_class.parse!('1990..1995') }.to raise_error RangeSentenceParser::InvalidSentenceError
+      expect { described_class.parse!('1990, 1995, 2000') }.to raise_error RangeSentenceParser::InvalidSentenceError
+    end
+  end
+
+  context '#valid?' do
+    it 'should be for valid sentences' do
+      ''.should be_a_valid_sentence
+      '1990'.should be_a_valid_sentence
+      '1990; 1995'.should be_a_valid_sentence
+      '1990-1995'.should be_a_valid_sentence
+      '1990-1995; 2000-2005'.should be_a_valid_sentence
+      '1990; 1995-2000; 2005; 2010-2015'.should be_a_valid_sentence
+    end
+  end
+
+  context '#invalid?' do
+    it 'should be for invalid sentences' do
+      '1990..1995'.should be_an_invalid_sentence
+      '1990, 1995, 2000'.should be_an_invalid_sentence
+    end
+  end
+end

data/spec/range_sentence_validator_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe RangeSentenceValidator do
+  subject do
+    AccountingReport.new
+  end
+
+  context 'using valid sentence' do
+    before do
+      subject.stub(:year_sentence).and_return('1990; 1995-2000; 2005')
+    end
+
+    it { should be_valid }
+  end
+
+  context 'using invalid sentence' do
+    before do
+      subject.stub(:year_sentence).and_return('1990, 1995-2000, 2005')
+    end
+
+    it { should be_invalid }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'active_model'
+
+require 'range_sentence_parser'
+require 'range_sentence_parser/invalid_sentence_error'
+require 'range_sentence_validator'
+
+require 'support/matchers'
+require 'support/accounting_report'

data/spec/support/accounting_report.rb

@@ -0,0 +1,5 @@
+class AccountingReport
+  include ActiveModel::Validations
+
+  validates :year_sentence, :range_sentence => true
+end

data/spec/support/matchers.rb

@@ -0,0 +1,17 @@
+RSpec::Matchers.define :be_parsed_to do |expected|
+  match do |actual|
+    RangeSentenceParser.parse!(actual) == expected
+  end
+end
+
+RSpec::Matchers.define :be_a_valid_sentence do |expected|
+  match do |actual|
+    RangeSentenceParser.valid?(actual)
+  end
+end
+
+RSpec::Matchers.define :be_an_invalid_sentence do |expected|
+  match do |actual|
+    RangeSentenceParser.invalid?(actual)
+  end
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: range_sentence_parser
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Gabriel Sobrinho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: &70159654975460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: *70159654975460
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70159654974520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: *70159654974520
+description: Parser for range sentences like '1990; 1995-2000; 2005'
+email:
+- gabriel.sobrinho@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/range_sentence_parser.rb
+- lib/range_sentence_parser/invalid_sentence_error.rb
+- lib/range_sentence_parser/version.rb
+- lib/range_sentence_validator.rb
+- range_sentence_parser.gemspec
+- spec/range_sentence_parser_spec.rb
+- spec/range_sentence_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/accounting_report.rb
+- spec/support/matchers.rb
+homepage: https://github.com/sobrinho/range_sentence_parser
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.11
+signing_key: 
+specification_version: 3
+summary: Parser for range sentences like '1990; 1995-2000; 2005'
+test_files:
+- spec/range_sentence_parser_spec.rb
+- spec/range_sentence_validator_spec.rb
+- spec/spec_helper.rb
+- spec/support/accounting_report.rb
+- spec/support/matchers.rb