frequency 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,5 @@
1
+ README.rdoc
2
+ lib/**/*.rb
3
+ bin/*
4
+ features/**/*.feature
5
+ LICENSE
@@ -0,0 +1,5 @@
1
+ *.sw?
2
+ .DS_Store
3
+ coverage
4
+ rdoc
5
+ pkg
data/LICENSE ADDED
@@ -0,0 +1,20 @@
1
+ Copyright (c) 2009 David James
2
+
3
+ Permission is hereby granted, free of charge, to any person obtaining
4
+ a copy of this software and associated documentation files (the
5
+ "Software"), to deal in the Software without restriction, including
6
+ without limitation the rights to use, copy, modify, merge, publish,
7
+ distribute, sublicense, and/or sell copies of the Software, and to
8
+ permit persons to whom the Software is furnished to do so, subject to
9
+ the following conditions:
10
+
11
+ The above copyright notice and this permission notice shall be
12
+ included in all copies or substantial portions of the Software.
13
+
14
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
15
+ EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
16
+ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
17
+ NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
18
+ LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
19
+ OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
20
+ WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
@@ -0,0 +1,18 @@
1
+ = frequency
2
+
3
+ Description goes here.
4
+
5
+ == Note on Patches/Pull Requests
6
+
7
+ * Fork the project.
8
+ * Make your feature addition or bug fix.
9
+ * Add tests for it. This is important so I don't break it in a
10
+ future version unintentionally.
11
+ * Commit, do not mess with rakefile, version, or history.
12
+ (if you want to have your own version, that is fine but
13
+ bump version in a commit by itself I can ignore when I pull)
14
+ * Send me a pull request. Bonus points for topic branches.
15
+
16
+ == Copyright
17
+
18
+ Copyright (c) 2009 David James. See LICENSE for details.
@@ -0,0 +1,50 @@
1
+ require 'rubygems'
2
+ require 'rake'
3
+
4
+ begin
5
+ require 'jeweler'
6
+ Jeweler::Tasks.new do |gem|
7
+ gem.name = "frequency"
8
+ gem.summary = %Q{Interpret and compare frequencies (such as hourly)}
9
+ gem.description = %Q{Interpret strings that represent frequencies (once a day, hourly, biennially, etc.)}
10
+ gem.email = "djames@sunlightfoundation.com"
11
+ gem.homepage = "http://github.com/djsun/frequency"
12
+ gem.authors = ["David James"]
13
+ gem.add_development_dependency "rspec"
14
+ # gem is a Gem::Specification...
15
+ # See http://www.rubygems.org/read/chapter/20 for additional settings
16
+ end
17
+ Jeweler::GemcutterTasks.new
18
+ rescue LoadError
19
+ puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
20
+ end
21
+
22
+ require 'spec/rake/spectask'
23
+ Spec::Rake::SpecTask.new(:spec) do |spec|
24
+ spec.libs << 'lib' << 'spec'
25
+ spec.spec_files = FileList['spec/**/*_spec.rb']
26
+ end
27
+
28
+ Spec::Rake::SpecTask.new(:rcov) do |spec|
29
+ spec.libs << 'lib' << 'spec'
30
+ spec.pattern = 'spec/**/*_spec.rb'
31
+ spec.rcov = true
32
+ end
33
+
34
+ task :spec => :check_dependencies
35
+
36
+ task :default => :spec
37
+
38
+ require 'rake/rdoctask'
39
+ Rake::RDocTask.new do |rdoc|
40
+ if File.exist?('VERSION')
41
+ version = File.read('VERSION')
42
+ else
43
+ version = ""
44
+ end
45
+
46
+ rdoc.rdoc_dir = 'rdoc'
47
+ rdoc.title = "frequency #{version}"
48
+ rdoc.rdoc_files.include('README*')
49
+ rdoc.rdoc_files.include('lib/**/*.rb')
50
+ end
data/VERSION ADDED
@@ -0,0 +1 @@
1
+ 0.1.0
@@ -0,0 +1,95 @@
1
+ class Frequency
2
+
3
+ class Undefined < RuntimeError; end
4
+
5
+ attr_accessor :plain_text
6
+
7
+ # Source: the Macintosh built-in dictionary:
8
+ # Notes:
9
+ # * biweekly is ambiguous so I left it out
10
+ # * biennially != biannually
11
+ FREQUENCIES = {
12
+ "each second" => 315_360_000,
13
+ "each minute" => 5_256_000,
14
+ "each hour" => 87_600,
15
+ "each day" => 3_650,
16
+ "each week" => 520,
17
+ "each month" => 120,
18
+ "each quarter" => 40,
19
+ "each year" => 10,
20
+ "hourly" => 87_600,
21
+ "daily" => 3_650,
22
+ "weekly" => 520,
23
+ "monthly" => 120,
24
+ "quarterly" => 40,
25
+ "biannually" => 20,
26
+ "annual" => 10,
27
+ "annually" => 10,
28
+ "yearly" => 10,
29
+ "biennial" => 5,
30
+ "biennially" => 5,
31
+ "decade" => 1,
32
+ "one time" => 0,
33
+ "one-time" => 0,
34
+ "other" => nil,
35
+ "unknown" => nil,
36
+ }
37
+
38
+ def initialize(string)
39
+ self.plain_text = string
40
+ end
41
+
42
+ def ==(other)
43
+ compare_safely(:==, other)
44
+ end
45
+
46
+ def <=>(other)
47
+ compare_safely(:<=>, other)
48
+ end
49
+
50
+ def <(other)
51
+ compare_safely(:<, other)
52
+ end
53
+
54
+ def <=(other)
55
+ compare_safely(:<=, other)
56
+ end
57
+
58
+ def >(other)
59
+ compare_safely(:>, other)
60
+ end
61
+
62
+ def >=(other)
63
+ compare_safely(:>=, other)
64
+ end
65
+
66
+ def per_decade
67
+ value = FREQUENCIES[plain_text]
68
+ value ? value : nil
69
+ end
70
+
71
+ def per_year
72
+ value = FREQUENCIES[plain_text]
73
+ value ? (value / 10.0) : nil
74
+ end
75
+
76
+ def valid?
77
+ FREQUENCIES.keys.include?(self.plain_text)
78
+ end
79
+
80
+ protected
81
+
82
+ def compare_safely(method, other)
83
+ if self.per_decade.nil?
84
+ raise Undefined, %(Numerical value for "#{self.plain_text}" is undefined, ) +
85
+ %( therefore a comparison with "#{other.plain_text}" is impossible)
86
+ elsif other.per_decade.nil?
87
+ raise Undefined, %(Numerical value for "#{other.plain_text}" is undefined, ) +
88
+ %( therefore a comparison with "#{self.plain_text}" is impossible)
89
+ else
90
+ self.per_decade.send(method, other.per_decade)
91
+ end
92
+ end
93
+
94
+ end
95
+
@@ -0,0 +1,101 @@
1
+ require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
2
+
3
+ describe "Frequency" do
4
+
5
+ describe "quarterly" do
6
+ before do
7
+ @freq = Frequency.new("quarterly")
8
+ end
9
+
10
+ it "should be valid" do
11
+ @freq.plain_text.should == "quarterly"
12
+ end
13
+
14
+ it "should be valid" do
15
+ @freq.valid?.should be_true
16
+ end
17
+
18
+ it "#per_year should be correct" do
19
+ @freq.per_year.should == 4.0
20
+ end
21
+
22
+ it "#per_decade should be correct" do
23
+ @freq.per_decade.should == 40
24
+ end
25
+
26
+ it "should be < monthly" do
27
+ @freq.should < Frequency.new('monthly')
28
+ end
29
+
30
+ it "should be <= monthly" do
31
+ @freq.should <= Frequency.new('monthly')
32
+ end
33
+
34
+ it "should be <= each quarter" do
35
+ @freq.should <= Frequency.new('each quarter')
36
+ end
37
+
38
+ it "should be == each quarter" do
39
+ @freq.should == Frequency.new('each quarter')
40
+ end
41
+
42
+ it "should be >= quarterly" do
43
+ @freq.should >= Frequency.new('quarterly')
44
+ end
45
+
46
+ it "should be > annually" do
47
+ @freq.should > Frequency.new('annually')
48
+ end
49
+ end
50
+
51
+ describe "sometimes" do
52
+ before do
53
+ @freq = Frequency.new("sometimes")
54
+ end
55
+
56
+ it "should be invalid" do
57
+ @freq.valid?.should be_false
58
+ end
59
+
60
+ it "#per_year should be nil" do
61
+ @freq.per_year.should == nil
62
+ end
63
+
64
+ it "#per_decade should be nil" do
65
+ @freq.per_decade.should == nil
66
+ end
67
+
68
+ it "< should be undefined" do
69
+ lambda {
70
+ @freq.should < Frequency.new('monthly')
71
+ }.should raise_error(Frequency::Undefined)
72
+ end
73
+
74
+ it "<= should be undefined" do
75
+ lambda {
76
+ @freq.should <= Frequency.new('monthly')
77
+ }.should raise_error(Frequency::Undefined)
78
+ end
79
+
80
+ it "== should be undefined" do
81
+ lambda {
82
+ @freq.should == Frequency.new('monthly')
83
+ }.should raise_error(Frequency::Undefined)
84
+ end
85
+
86
+ it ">= should be undefined" do
87
+ lambda {
88
+ @freq.should >= Frequency.new('monthly')
89
+ }.should raise_error(Frequency::Undefined)
90
+ end
91
+
92
+ it "> should be undefined" do
93
+ lambda {
94
+ @freq.should > Frequency.new('monthly')
95
+ }.should raise_error(Frequency::Undefined)
96
+ end
97
+ end
98
+
99
+ end
100
+
101
+
@@ -0,0 +1,9 @@
1
+ $LOAD_PATH.unshift(File.dirname(__FILE__))
2
+ $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
3
+ require 'frequency'
4
+ require 'spec'
5
+ require 'spec/autorun'
6
+
7
+ Spec::Runner.configure do |config|
8
+
9
+ end
metadata ADDED
@@ -0,0 +1,74 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: frequency
3
+ version: !ruby/object:Gem::Version
4
+ version: 0.1.0
5
+ platform: ruby
6
+ authors:
7
+ - David James
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+
12
+ date: 2009-10-12 00:00:00 -04:00
13
+ default_executable:
14
+ dependencies:
15
+ - !ruby/object:Gem::Dependency
16
+ name: rspec
17
+ type: :development
18
+ version_requirement:
19
+ version_requirements: !ruby/object:Gem::Requirement
20
+ requirements:
21
+ - - ">="
22
+ - !ruby/object:Gem::Version
23
+ version: "0"
24
+ version:
25
+ description: Interpret strings that represent frequencies (once a day, hourly, biennially, etc.)
26
+ email: djames@sunlightfoundation.com
27
+ executables: []
28
+
29
+ extensions: []
30
+
31
+ extra_rdoc_files:
32
+ - LICENSE
33
+ - README.rdoc
34
+ files:
35
+ - .document
36
+ - .gitignore
37
+ - LICENSE
38
+ - README.rdoc
39
+ - Rakefile
40
+ - VERSION
41
+ - lib/frequency.rb
42
+ - spec/frequency_spec.rb
43
+ - spec/spec_helper.rb
44
+ has_rdoc: true
45
+ homepage: http://github.com/djsun/frequency
46
+ licenses: []
47
+
48
+ post_install_message:
49
+ rdoc_options:
50
+ - --charset=UTF-8
51
+ require_paths:
52
+ - lib
53
+ required_ruby_version: !ruby/object:Gem::Requirement
54
+ requirements:
55
+ - - ">="
56
+ - !ruby/object:Gem::Version
57
+ version: "0"
58
+ version:
59
+ required_rubygems_version: !ruby/object:Gem::Requirement
60
+ requirements:
61
+ - - ">="
62
+ - !ruby/object:Gem::Version
63
+ version: "0"
64
+ version:
65
+ requirements: []
66
+
67
+ rubyforge_project:
68
+ rubygems_version: 1.3.5
69
+ signing_key:
70
+ specification_version: 3
71
+ summary: Interpret and compare frequencies (such as hourly)
72
+ test_files:
73
+ - spec/frequency_spec.rb
74
+ - spec/spec_helper.rb