castiel 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    N2FkY2JiNzMwNmIwZDFmYzY3ODU0OGQ2YzBlMzgzYzIwM2FlM2FiNQ==
+  data.tar.gz: !binary |-
+    YTAxM2M4YTdiZTYyYzZlOWViNTg2ZWY4Y2JlOTlkNWU2MTZhMTU1Ng==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    ZTQzY2IxYWI3ODhlNWQyYTZiYjU2MDg5MzI2ZDRkMTQ0MGExOTlhNDcyODBh
+    NjYzOTZjYjk2NDViN2FmYWY4NzBjZGJhMTRlZTQ1MGU0MzlkOGUwNGM2NmFm
+    N2I3ZDY4MzAxM2M4ZjRhNGM2MGJjM2M0MWY5MDNmZGUwMDc4MTI=
+  data.tar.gz: !binary |-
+    ZjNkYTE3NTNjMDBjMmZiODZhNGEyNzFlZTk4NTBmZjA1ODk1NTRkY2U1YTEz
+    MTU4ZjhiZTM5YzViMTkwNDg3MjA5YzI2ZjU2OTY1MWE2NTczZTc0ZTcyZjA2
+    YWIxMTIyNDQ0ZjI2NTU2OTY0ZTU4YjlkMjA2MTYyNWQ4N2ZmYjc=

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/Gemfile

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

data/Guardfile

@@ -0,0 +1,5 @@
+guard 'rspec' do
+  watch(%r{^spec/.+_spec\.rb})
+  watch(%r{^lib/(.+)\.rb})     { |m| "spec/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb') { "spec" }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Adilson Carvalho
+
+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,41 @@
+# Castiel
+
+[Castiel](http://va.mu/cUmX) was written to rescue me from hell every time I have to write any kind
+of script that must deal with dates and times to be parsed on command line.
+
+It is common to me to write summarization daemons that must accept command lines like:
+
+`sales-count yesterday`
+
+or
+
+`hit-count yesterday today 11..17`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'castiel'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install castiel
+
+## Usage
+
+````ruby
+Castiel.parse 'yesterday today 1977-04-13'
+# => [2013-04-21 00:00:00 -0300, 2013-04-22 00:00:00 -0300, 1977-04-13 00:00:00 -0300]
+````
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'bundler'
+
+Bundler.setup
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/castiel.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'castiel/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "castiel"
+  spec.version       = Castiel::VERSION
+  spec.authors       = ["Adilson Carvalho"]
+  spec.email         = ["adilson@adilsoncarvalho.com.br"]
+  spec.description   = 'Extension do add date and time parsing capabilities to OptionsParse'
+  spec.summary       = 'Extension do add date and time parsing capabilities to OptionsParse'
+  spec.homepage      = 'https://github.com/adilsoncarvalho/castiel'
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 0.9.2'
+  spec.add_development_dependency 'rspec', '~> 2.5'
+  spec.add_development_dependency 'fuubar', '~> 1.1.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'growl'
+end

data/lib/castiel.rb

@@ -0,0 +1,32 @@
+require "castiel/version"
+
+module Castiel
+
+  module Elements
+    # elements stuff
+    autoload :BaseElement,    'castiel/elements/base_element'
+    autoload :DateElement,    'castiel/elements/date_element'
+    autoload :HourElement,    'castiel/elements/hour_element'
+    autoload :SymbolElement,  'castiel/elements/symbol_element'
+  end
+
+  module Parsers
+    # parsers
+    autoload :BaseParser,     'castiel/parsers/base_parser'
+    autoload :DateTimeParser, 'castiel/parsers/date_time_parser'
+  end
+
+  def self.default_parser_class
+    @default_parser ||= Castiel::Parsers::DateTimeParser
+  end
+
+  def self.default_parser_class=(klass)
+    raise 'Parser class must have a "parse" method declared' unless klass.instance_methods.include? :parse
+    @default_parser = klass
+  end
+
+  def self.parse(elements)
+    default_parser_class.new.parse elements
+  end
+
+end

data/lib/castiel/elements/base_element.rb

@@ -0,0 +1,15 @@
+module Castiel
+  module Elements
+
+    class BaseElement
+      def match?(element, context = nil)
+        true
+      end
+
+      def evaluate(element, context = nil)
+        element
+      end
+    end
+
+  end
+end

data/lib/castiel/elements/date_element.rb

@@ -0,0 +1,17 @@
+module Castiel
+  module Elements
+
+    class DateElement < BaseElement
+      def match?(element, context = nil)
+        return false unless element =~ /^\d{4}[-\/]\d{2}[-\/]\d{2}|\d{2}[-\/]\d{2}[-\/]\d{4}$/
+        return false unless ::Date.parse(element) rescue nil
+        true
+      end
+
+      def evaluate(element, context = nil)
+        ::Date.parse(element).to_time
+      end
+    end
+
+  end
+end

data/lib/castiel/elements/hour_element.rb

@@ -0,0 +1,15 @@
+module Castiel
+  module Elements
+
+    class HourElement < BaseElement
+      def match?(element, context = nil)
+        element =~ /^(\d|[01]\d|2[0-3])(:\d\d)?$/
+      end
+
+      def evaluate(element, context = nil)
+        element.to_i
+      end
+    end
+
+  end
+end

data/lib/castiel/elements/symbol_element.rb

@@ -0,0 +1,29 @@
+module Castiel
+  module Elements
+
+    class SymbolElement < BaseElement
+      def match?(element, context = nil)
+        element = element.to_s.downcase
+        respond_to? "run_#{element}"
+      end
+
+      def evaluate(element, context = nil)
+        element = element.to_s.downcase
+        send "run_#{element}", element, context
+      end
+
+      def run_today(element, context = nil)
+        ::Date.today.to_time
+      end
+
+      def run_yesterday(element, context = nil)
+        (::Date.today - 1).to_time
+      end
+
+      def run_tomorrow(element, context = nil)
+        (::Date.today + 1).to_time
+      end
+    end
+
+  end
+end

data/lib/castiel/parsers/base_parser.rb

@@ -0,0 +1,27 @@
+module Castiel
+  module Parsers
+
+    class BaseParser
+      def parsers
+        @parsers ||= []
+      end
+
+      def <<(element)
+        parsers << element
+      end
+
+      def parse(elements)
+        elements = elements.split ' ' if elements.is_a? String
+        elements.collect{|element| parse_element element}
+      end
+
+      def parse_element(element, context = nil)
+        parsers.each do |parser|
+          return parser.evaluate(element, context) if parser.match? element
+        end
+        nil
+      end
+    end
+
+  end
+end

data/lib/castiel/parsers/date_time_parser.rb

@@ -0,0 +1,13 @@
+module Castiel
+  module Parsers
+
+    class DateTimeParser < BaseParser
+      def initialize
+        parsers << Castiel::Elements::SymbolElement.new
+        parsers << Castiel::Elements::DateElement.new
+        parsers << Castiel::Elements::HourElement.new
+      end
+    end
+
+  end
+end

data/lib/castiel/version.rb

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

data/spec/castiel_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+describe 'Castiel' do
+  let(:subject) { Castiel }
+
+  describe '.default_parser_class' do
+    it{ subject.default_parser_class.should == Castiel::Parsers::DateTimeParser }
+  end
+
+  describe '.default_parser_class=' do
+    class InvalidParserClass; end
+    it{ lambda{ subject.default_parser_class = InvalidParserClass }.should raise_error }
+
+    class ValidParserClass
+      def parse(elements); end
+    end
+
+    it do
+      subject.default_parser_class = ValidParserClass
+      subject.default_parser_class.should == ValidParserClass
+    end
+
+  end
+
+  describe '.parse' do
+    it 'Should call the default parser and pass the given elements' do
+      parser_double = double(:parser)
+      parser_double.should_receive(:new)
+        .once
+        .and_return(parser_double)
+      parser_double.should_receive(:parse)
+        .with(:elements)
+        .once
+        .and_return(:parsed_elements)
+
+      subject.should_receive(:default_parser_class)
+        .once
+        .and_return(parser_double)
+
+      subject.parse(:elements).should == :parsed_elements
+    end
+  end
+
+end

data/spec/elements/base_element_spec.rb

@@ -0,0 +1,14 @@
+require 'spec_helper'
+
+describe Castiel::Elements::BaseElement do
+
+  describe '#match?' do
+    it{ subject.match?('').should be_true  }
+    it{ subject.match?(nil).should be_true }
+  end
+
+  describe '#evaluate' do
+    it{ subject.evaluate(:anything).should == :anything }
+  end
+
+end

data/spec/elements/date_element_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Castiel::Elements::DateElement do
+
+  describe '#match?' do
+    context 'Should return true' do
+      it{ subject.match?('1977-03-14').should be_true }
+      it{ subject.match?('14/03/1977').should be_true }
+    end
+
+    context 'Should return false' do
+      it{ subject.match?('1977-03').should be_false    }
+      it{ subject.match?('14 03 1977').should be_false }
+    end
+  end
+
+  describe '#evaluate' do
+    it{ subject.evaluate('1977-03-14').should == Time.parse('1977-03-14 00:00') }
+    it{ subject.evaluate('14/03/1977').should == Time.parse('1977-03-14 00:00') }
+  end
+
+end

data/spec/elements/hour_element_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Castiel::Elements::HourElement do
+
+  describe '#match?' do
+    context 'Should return true' do
+      it{ ('0'..'23').each {|hour| subject.match?(hour).should be_true} }
+      it{ ('00'..'23').each{|hour| subject.match?(hour).should be_true} }
+    end
+
+    context 'Should return false' do
+      it{ ('24'..'99').each{|hour| subject.match?(hour).should be_false} }
+      it{ subject.match?('').should be_false }
+      it{ subject.match?(nil).should be_false }
+    end
+  end
+
+  describe '#evaluate' do
+    it{ ('0'..'23').each{|hour| subject.evaluate(hour).should == hour.to_i}}
+  end
+
+end

data/spec/elements/symbol_element_spec.rb

@@ -0,0 +1,47 @@
+require 'spec_helper'
+
+describe Castiel::Elements::SymbolElement do
+
+  describe '#match?' do
+    context 'Should return true' do
+      context 'when written the proper way' do
+        it { subject.match?('yesterday').should be_true }
+        it { subject.match?('today').should be_true     }
+        it { subject.match?('tomorrow').should be_true  }
+      end
+
+      context 'when written with different case' do
+        it { subject.match?('YESTERDAY').should be_true }
+        it { subject.match?('TODAY').should be_true     }
+        it { subject.match?('TOMORROW').should be_true  }
+      end
+
+      context 'when using symbols on any case' do
+        it { subject.match?(:yesterday).should be_true }
+        it { subject.match?(:today).should be_true     }
+        it { subject.match?(:tomorrow).should be_true  }
+        it { subject.match?(:YESTERDAY).should be_true }
+        it { subject.match?(:TODAY).should be_true     }
+        it { subject.match?(:TOMORROW).should be_true  }
+      end
+    end
+
+    context 'Should return false' do
+      it { subject.match?('teretete').should be_false }
+      it { subject.match?('').should be_false         }
+      it { subject.match?(nil).should be_false        }
+    end
+  end
+
+  describe '#evaluate' do
+    # making the clock go back in time on my favorite day ;)
+    before(:each)   { Date.stub(:today) { Date.parse('1977-03-14') } }
+    let(:yesterday) { (Date.today - 1).to_time }
+    let(:today)     { (Date.today).to_time     }
+    let(:tomorrow)  { (Date.today + 1).to_time }
+
+    it{ subject.evaluate('yesterday').should == yesterday }
+    it{ subject.evaluate('today').should     == today     }
+    it{ subject.evaluate('tomorrow').should  == tomorrow  }
+  end
+end

data/spec/parsers/base_parser_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Castiel::Parsers::BaseParser do
+
+  describe '#parsers' do
+    it{ subject.parsers.empty?.should be_true }
+  end
+
+  describe '#<<' do
+    it 'Should add element parsers into parsers list' do
+      subject << :element1
+      subject << :element2
+      subject << :element3
+
+      subject.parsers.should == [:element1, :element2, :element3]
+    end
+  end
+
+  describe '#parse' do
+    before(:each) do
+      subject.should_receive(:parse_element)
+        .with('element1')
+        .once
+        .and_return('element1')
+      subject.should_receive(:parse_element)
+        .with('element2')
+        .once
+        .and_return('element2')
+      subject.should_receive(:parse_element)
+        .with('element3')
+        .once
+        .and_return('element3')
+    end
+
+    it{ subject.parse('element1 element2 element3').should == %w(element1 element2 element3) }
+    it{ subject.parse(%w(element1 element2 element3)).should == %w(element1 element2 element3) }
+  end
+
+  describe '#parse_element' do
+    it 'Should evaluate for the element who says match and stop' do
+      e1 = double(:element_1)
+      e1.should_receive(:match?)
+        .with(:element)
+        .and_return(false)
+
+      e2 = double(:element_2)
+      e2.should_receive(:match?)
+        .with(:element)
+        .and_return(true)
+      e2.should_receive(:evaluate)
+        .with(:element, nil)
+        .and_return(:success)
+
+      e3 = double(:element_3)
+      e3.should_receive(:match?)
+        .with(:element)
+        .exactly(0)
+
+      subject << e1
+      subject << e2
+      subject << e3
+
+      subject.parse_element(:element).should == :success
+    end
+
+    it 'Should return nil if no element says match' do
+      e1 = double(:element_1)
+      e1.should_receive(:match?)
+        .with(:element)
+        .and_return(false)
+
+      e2 = double(:element_2)
+      e2.should_receive(:match?)
+        .with(:element)
+        .and_return(false)
+
+      e3 = double(:element_3)
+      e3.should_receive(:match?)
+        .with(:element)
+        .and_return(false)
+
+      subject << e1
+      subject << e2
+      subject << e3
+
+      subject.parse_element(:element).should be_nil
+    end
+  end
+
+end

data/spec/parsers/date_time_parser_spec.rb

@@ -0,0 +1,15 @@
+require 'spec_helper'
+
+describe Castiel::Parsers::DateTimeParser do
+
+  describe '#parsers' do
+    it 'Should contain the following parsers' do
+      subject.parsers.size.should == 3
+
+      subject.parsers[0].class.should == Castiel::Elements::SymbolElement
+      subject.parsers[1].class.should == Castiel::Elements::DateElement
+      subject.parsers[2].class.should == Castiel::Elements::HourElement
+    end
+  end
+
+end

data/spec/spec.opts

@@ -0,0 +1,3 @@
+--colour
+--format Fuubar
+--backtrace

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rubygems'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'castiel'
+require 'rspec'
+
+RSpec.configure do |config|
+  # see spec.opts
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: castiel
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Adilson Carvalho
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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: growl
+  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'
+description: Extension do add date and time parsing capabilities to OptionsParse
+email:
+- adilson@adilsoncarvalho.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- castiel.gemspec
+- lib/castiel.rb
+- lib/castiel/elements/base_element.rb
+- lib/castiel/elements/date_element.rb
+- lib/castiel/elements/hour_element.rb
+- lib/castiel/elements/symbol_element.rb
+- lib/castiel/parsers/base_parser.rb
+- lib/castiel/parsers/date_time_parser.rb
+- lib/castiel/version.rb
+- spec/castiel_spec.rb
+- spec/elements/base_element_spec.rb
+- spec/elements/date_element_spec.rb
+- spec/elements/hour_element_spec.rb
+- spec/elements/symbol_element_spec.rb
+- spec/parsers/base_parser_spec.rb
+- spec/parsers/date_time_parser_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+homepage: https://github.com/adilsoncarvalho/castiel
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Extension do add date and time parsing capabilities to OptionsParse
+test_files:
+- spec/castiel_spec.rb
+- spec/elements/base_element_spec.rb
+- spec/elements/date_element_spec.rb
+- spec/elements/hour_element_spec.rb
+- spec/elements/symbol_element_spec.rb
+- spec/parsers/base_parser_spec.rb
+- spec/parsers/date_time_parser_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+has_rdoc: