frequency 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,5 @@
+*.sw?
+.DS_Store
+coverage
+rdoc
+pkg

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 David James
+
+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.rdoc

@@ -0,0 +1,18 @@
+= frequency
+
+Description goes here.
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 David James. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "frequency"
+    gem.summary = %Q{Interpret and compare frequencies (such as hourly)}
+    gem.description = %Q{Interpret strings that represent frequencies (once a day, hourly, biennially, etc.)}
+    gem.email = "djames@sunlightfoundation.com"
+    gem.homepage = "http://github.com/djsun/frequency"
+    gem.authors = ["David James"]
+    gem.add_development_dependency "rspec"
+    # gem is a Gem::Specification...
+    # See http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "frequency #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/frequency.rb

@@ -0,0 +1,95 @@
+class Frequency
+  
+  class Undefined < RuntimeError; end
+  
+  attr_accessor :plain_text
+
+  # Source: the Macintosh built-in dictionary:
+  # Notes:
+  # * biweekly is ambiguous so I left it out
+  # * biennially != biannually
+  FREQUENCIES = {
+    "each second"  => 315_360_000,
+    "each minute"  =>   5_256_000,
+    "each hour"    =>      87_600,
+    "each day"     =>       3_650,
+    "each week"    =>         520,
+    "each month"   =>         120,
+    "each quarter" =>          40,
+    "each year"    =>          10,
+    "hourly"       =>      87_600,
+    "daily"        =>       3_650,
+    "weekly"       =>         520,
+    "monthly"      =>         120,
+    "quarterly"    =>          40,
+    "biannually"   =>          20,
+    "annual"       =>          10,
+    "annually"     =>          10,
+    "yearly"       =>          10,
+    "biennial"     =>           5,
+    "biennially"   =>           5,
+    "decade"       =>           1,
+    "one time"     =>           0,
+    "one-time"     =>           0,
+    "other"        =>         nil,
+    "unknown"      =>         nil,
+  }
+  
+  def initialize(string)
+    self.plain_text = string
+  end
+  
+  def ==(other)
+    compare_safely(:==, other)
+  end
+  
+  def <=>(other)
+    compare_safely(:<=>, other)
+  end
+
+  def <(other)
+    compare_safely(:<, other)
+  end
+
+  def <=(other)
+    compare_safely(:<=, other)
+  end
+  
+  def >(other)
+    compare_safely(:>, other)
+  end
+
+  def >=(other)
+    compare_safely(:>=, other)
+  end
+  
+  def per_decade
+    value = FREQUENCIES[plain_text]
+    value ? value : nil
+  end
+  
+  def per_year
+    value = FREQUENCIES[plain_text]
+    value ? (value / 10.0) : nil
+  end
+
+  def valid?
+    FREQUENCIES.keys.include?(self.plain_text)
+  end
+  
+  protected
+  
+  def compare_safely(method, other)
+    if self.per_decade.nil?
+      raise Undefined, %(Numerical value for "#{self.plain_text}" is undefined, ) +
+        %( therefore a comparison with "#{other.plain_text}" is impossible)
+    elsif other.per_decade.nil?
+      raise Undefined, %(Numerical value for "#{other.plain_text}" is undefined, ) +
+        %( therefore a comparison with "#{self.plain_text}" is impossible)
+    else
+      self.per_decade.send(method, other.per_decade)
+    end
+  end
+
+end
+

data/spec/frequency_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "Frequency" do
+
+  describe "quarterly" do
+    before do
+      @freq = Frequency.new("quarterly")
+    end
+
+    it "should be valid" do
+      @freq.plain_text.should == "quarterly"
+    end
+  
+    it "should be valid" do
+      @freq.valid?.should be_true
+    end
+
+    it "#per_year should be correct" do
+      @freq.per_year.should == 4.0
+    end
+
+    it "#per_decade should be correct" do
+      @freq.per_decade.should == 40
+    end
+    
+    it "should be < monthly" do
+      @freq.should < Frequency.new('monthly')
+    end
+
+    it "should be <= monthly" do
+      @freq.should <= Frequency.new('monthly')
+    end
+
+    it "should be <= each quarter" do
+      @freq.should <= Frequency.new('each quarter')
+    end
+
+    it "should be == each quarter" do
+      @freq.should == Frequency.new('each quarter')
+    end
+
+    it "should be >= quarterly" do
+      @freq.should >= Frequency.new('quarterly')
+    end
+
+    it "should be > annually" do
+      @freq.should > Frequency.new('annually')
+    end
+  end
+  
+  describe "sometimes" do
+    before do
+      @freq = Frequency.new("sometimes")
+    end
+    
+    it "should be invalid" do
+      @freq.valid?.should be_false
+    end
+
+    it "#per_year should be nil" do
+      @freq.per_year.should == nil
+    end
+
+    it "#per_decade should be nil" do
+      @freq.per_decade.should == nil
+    end
+
+    it "< should be undefined" do
+      lambda {
+        @freq.should < Frequency.new('monthly')
+      }.should raise_error(Frequency::Undefined)
+    end
+
+    it "<= should be undefined" do
+      lambda {
+        @freq.should <= Frequency.new('monthly')
+      }.should raise_error(Frequency::Undefined)
+    end
+    
+    it "== should be undefined" do
+      lambda {
+        @freq.should == Frequency.new('monthly')
+      }.should raise_error(Frequency::Undefined)
+    end
+
+    it ">= should be undefined" do
+      lambda {
+        @freq.should >= Frequency.new('monthly')
+      }.should raise_error(Frequency::Undefined)
+    end
+    
+    it "> should be undefined" do
+      lambda {
+        @freq.should > Frequency.new('monthly')
+      }.should raise_error(Frequency::Undefined)
+    end
+  end
+  
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'frequency'
+require 'spec'
+require 'spec/autorun'
+
+Spec::Runner.configure do |config|
+  
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: frequency
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- David James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-10-12 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Interpret strings that represent frequencies (once a day, hourly, biennially, etc.)
+email: djames@sunlightfoundation.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/frequency.rb
+- spec/frequency_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/djsun/frequency
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Interpret and compare frequencies (such as hourly)
+test_files: 
+- spec/frequency_spec.rb
+- spec/spec_helper.rb