nickel 0.0.6 → 0.1.0

data/spec/spec_helper.rb

@@ -0,0 +1,22 @@
+if ENV['TRAVIS'] && ENV['COVERALLS'] && RUBY_ENGINE == 'ruby'
+  require 'coveralls'
+  Coveralls.wear!
+end
+
+RSpec.configure do |config|
+  config.order = 'random'
+  config.expect_with(:rspec){ |c| c.syntax = :expect }
+  config.mock_with(:rspec){ |c| c.syntax = :expect }
+  config.filter_run_excluding broken: true
+
+  # make sure warnings are not shown when testing deprecated methods
+  config.around(:each, :deprecated) do |example|
+    original_verbose = $VERBOSE
+    begin
+      $VERBOSE = nil
+      example.run
+    ensure
+      $VERBOSE = original_verbose
+    end
+  end
+end

metadata

@@ -1,73 +1,162 @@
 --- !ruby/object:Gem::Specification
 name: nickel
 version: !ruby/object:Gem::Version
-  version: 0.0.6
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Lou Zell
+- Iain Beeston
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-20 00:00:00.000000000 Z
-dependencies: []
+date: 2014-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rake
+  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: 3.0.0.beta2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  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: yard
+  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: kramdown
+  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: Extracts date, time, and message information from naturally worded text.
-email: lzell11@gmail.com
+email: 
 executables: []
 extensions: []
-extra_rdoc_files:
-- README.rdoc
+extra_rdoc_files: []
 files:
-- History.txt
+- .gitignore
+- .travis.yml
+- .yardopts
+- CHANGELOG.md
+- Gemfile
 - License.txt
-- README.rdoc
+- README.md
 - Rakefile
-- nickel.gemspec
+- bin/run_specs.sh
 - lib/nickel.rb
 - lib/nickel/construct.rb
 - lib/nickel/construct_finder.rb
 - lib/nickel/construct_interpreter.rb
-- lib/nickel/instance_from_hash.rb
 - lib/nickel/nlp.rb
+- lib/nickel/nlp_query.rb
+- lib/nickel/nlp_query_constants.rb
 - lib/nickel/occurrence.rb
-- lib/nickel/query.rb
-- lib/nickel/query_constants.rb
+- lib/nickel/version.rb
 - lib/nickel/zdate.rb
 - lib/nickel/ztime.rb
-- lib/nickel/ruby_ext/calling_method.rb
-- lib/nickel/ruby_ext/to_s2.rb
-- test/compare.rb
-- test/nlp_test.rb
-- test/nlp_tests_helper.rb
-- test/zdate_test.rb
-- test/ztime_test.rb
-- spec/nickel_spec.rb
-homepage: http://github.com/lzell/nickel
-licenses: []
+- nickel.gemspec
+- spec/lib/nickel/nlp_spec.rb
+- spec/lib/nickel/occurrence_spec.rb
+- spec/lib/nickel/zdate_spec.rb
+- spec/lib/nickel/ztime_spec.rb
+- spec/lib/nickel_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/iainbeeston/nickel
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options:
-- --main
-- README.rdoc
-- --title
-- Nickel
+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.23
+rubygems_version: 2.1.11
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Natural language date, time, and message parsing.
-test_files: []
+test_files:
+- spec/lib/nickel/nlp_spec.rb
+- spec/lib/nickel/occurrence_spec.rb
+- spec/lib/nickel/zdate_spec.rb
+- spec/lib/nickel/ztime_spec.rb
+- spec/lib/nickel_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true

data/History.txt

@@ -1,11 +0,0 @@
-== 0.0.1 2009-03-22
-
-Initial release!
-
-== 0.0.2 2009-03-30
-
-No www in request
-
-== 0.0.3 2010-04-02
-
-Able to set current time for query

data/README.rdoc

@@ -1,69 +0,0 @@
-=== Nickel extracts date, time, and message information from naturally worded text.
-
-=== Install
-  
-  gem install nickel
-
-=== Usage
-
-==== A single occurrence
-  n = Nickel.parse("use the force on july 1st at 9am", Time.now)
-  n.message                       #=> "use the force"
-  n.occurrences.first.start_date  #=> "20110701"
-
-==== A daily occurrence
-  n = Nickel.parse "wake up everyday at 11am"
-  n.message                       # => wake up
-  n.occurrences[0].type           # => daily
-  n.occurrences[0].start_time     # => 11:00:00
-  
-==== A weekly occurrence
-  n = Nickel.parse "guitar lessons every tuesday at 5pm"
-  n.message                       # => guitar lessons
-  n.occurrences[0].type           # => weekly
-  n.occurrences[0].day_of_week    # => tue
-  n.occurrences[0].interval       # => 1
-  n.occurrences[0].start_time     # => 17:00:00
-
-==== A day monthly occurrence
-  n = Nickel.parse "drink specials on the second thursday of every month"
-  n.message                       # => drink specials
-  n.occurrences[0].type           # => daymonthly
-  n.occurrences[0].day_of_week    # => thu
-  n.occurrences[0].week_of_month  # => 2
-  n.occurrences[0].interval       # => 1
-  
-==== A date monthly occurrence
-  n = Nickel.parse "pay credit card every month on the 22nd"
-  n.message                       # => pay credit card
-  n.occurrences[0].type           # => datemonthly
-  n.occurrences[0].date_of_month  # => 22
-  n.occurrences[0].interval       # => 1
-
-==== Multiple occurrences
-  n = Nickel.parse "band meeting every monday and wednesday at 2pm"
-  n.message                       # => band meeting
-  n.occurrences[0].type           # => weekly
-  n.occurrences[0].day_of_week    # => mon
-  n.occurrences[0].start_time     # => 14:00:00
-  n.occurrences[1].type           # => weekly
-  n.occurrences[1].day_of_week    # => wed
-  n.occurrences[1].start_time     # => 14:00:00
-
-==== Setting current time
-
-  n = Nickel.parse "lunch 3 days from now", DateTime.new(2010,3,31)
-  n.message                       # => lunch
-  n.occurrences[0].start_date     # => 20100403
-
-
-Running Tests
-=======
-$ rake test
-
-If you do not have RUBYOPT set: 
-$ RUBYOPT='rubygems' rake test
-
-
-Copyright (c) 2008-2011 Lou Zell, released under the MIT license
-

data/lib/nickel/instance_from_hash.rb

@@ -1,13 +0,0 @@
-# Ruby Nickel Library 
-# Copyright (c) 2008-2011 Lou Zell, lzell11@gmail.com, http://hazelmade.com
-# MIT License [http://www.opensource.org/licenses/mit-license.php]
-
-module InstanceFromHash
-
-  def initialize(h)
-    h.each do |k,v|
-      instance_variable_set("@#{k}", v)
-    end
-    super()
-  end
-end

data/lib/nickel/ruby_ext/calling_method.rb

@@ -1,10 +0,0 @@
-module Kernel
-private
-  def method_name
-    caller[0] =~ /`([^']*)'/ and $1
-  end
-  def calling_method
-    md = caller[1].match(/(\d+):in `([^']*)'/)
-    md && "#{md[2]}:#{md[1]}"
-  end
-end

data/lib/nickel/ruby_ext/to_s2.rb

@@ -1,12 +0,0 @@
-class Fixnum
-  def to_s2
-    str = self.to_s
-    str.sub(/^(\d)$/,'0\1')
-  end
-end
-
-class String
-  def to_s2
-    sub(/^(\d)$/,'0\1')
-  end
-end

data/spec/nickel_spec.rb

@@ -1,165 +0,0 @@
-# Run with: 
-# ~/dev/nickel(master)$ rspec test/nickel_spec.rb
-require File.expand_path(File.dirname(__FILE__) + "/../lib/nickel")
-
-
-describe "A single date" do 
-  before(:all) { @n = Nickel.query "oct 15 09" }
-  
-  it "should have an empty message" do 
-    @n.message.should be_empty
-  end
-  
-  it "should have a start date" do 
-    @n.occurrences.size.should == 1
-    @n.occurrences.first.start_date.should == "20091015"
-  end
-end
-
-describe "A daily occurrence" do 
-  before(:all) do 
-    @n = Nickel.query "wake up everyday at 11am"
-    @occurs = @n.occurrences.first
-  end
-  
-  it "should have a message" do 
-    @n.message.should == "wake up"
-  end
-  
-  it "should be daily" do
-    @occurs.type.should == "daily"
-  end
-  
-  it "should have a start time" do 
-    @occurs.start_time.should == "11:00:00"
-  end
-end
-
-
-describe "A weekly occurrence" do
-  before(:all) do 
-    @n = Nickel.query "guitar lessons every tuesday at 5pm"
-    @occurs = @n.occurrences.first
-  end
-  
-  it "should have a message" do
-    @n.message.should == "guitar lessons"
-  end
-  
-  it "should be weekly" do 
-    @occurs.type.should == "weekly"
-  end
-  
-  
-  it "should occur on tuesdays" do
-    @occurs.day_of_week.should == "tue"
-  end
-  
-  it "should occur once per week" do 
-    @occurs.interval.should == 1
-  end
-  
-  it "should start at 5pm" do 
-    @occurs.start_time.should == "17:00:00"
-  end
-  
-  it "should have a start date" do 
-    @occurs.start_date.should_not be_nil
-  end
-  
-  it "should not have an end date" do 
-    @occurs.end_date.should be_nil
-  end
-end
-
-
-describe "A day monthly occurrence" do 
-  before(:all) do 
-    @n = Nickel.query "drink specials on the second thursday of every month"
-    @occurs = @n.occurrences.first
-  end
-  
-  it "should have a message" do 
-    @n.message.should == "drink specials"
-  end
-  
-  it "should be day monthly" do 
-    @occurs.type.should == "daymonthly"
-  end
-  
-  it "should occur on second thursday of every month" do 
-    @occurs.week_of_month.should == 2
-    @occurs.day_of_week.should == "thu"
-  end
-  
-  it "should occur once per month" do 
-    @occurs.interval.should == 1
-  end
-end
-
-
-
-describe "A date monthly occurrence" do 
-  before(:all) do 
-    @n = Nickel.query "pay credit card every month on the 22nd"
-    @occurs = @n.occurrences.first
-  end
-  
-  it "should have a message" do 
-    @n.message.should == "pay credit card"
-  end
-  
-  it "should be date monthly" do 
-    @occurs.type.should == "datemonthly"
-  end
-  
-  it "should occur on the 22nd of every month" do
-    @occurs.date_of_month.should == 22
-  end
-  
-  it "should occur once per month" do 
-    @occurs.interval.should == 1
-  end
-end
-
-
-describe "Multiple occurrences" do 
-  before(:all) do 
-    @n = Nickel.query "band meeting every monday and wednesday at 2pm"
-  end
-  
-  it "should have a message" do 
-    @n.message.should == "band meeting"
-  end
-  
-  it "should have two occurrences" do 
-    @n.occurrences.size.should == 2
-  end
-  
-  it "should occur on mondays and wednesdays" do 
-    days = @n.occurrences.collect {|occ| occ.day_of_week}
-    days.include?("mon").should be_true
-    days.include?("wed").should be_true
-    days.size.should == 2
-  end
-  
-  it "should occur at 2pm on both days" do 
-    @n.occurrences[0].start_time.should == "14:00:00"
-    @n.occurrences[1].start_time.should == "14:00:00"
-  end
-end
-
-describe "Setting current time" do
-  
-  it "should occur on a date relative to the current time passed in" do
-    n = Nickel.query "lunch 3 days from now", DateTime.new(2009,05,28)
-    n.occurrences.first.start_date.should == "20090531"
-  end
-  
-  it "should raise an error if the current time argument is not a datetime or time object" do
-    lambda{ 
-      Nickel.query "lunch 3 days from now", Date.new(2009,05,28) 
-    }.should raise_error("You must pass in a ruby DateTime or Time class object")    
-  end
-end
-