birthday 0.0.1

data/.gitignore

@@ -0,0 +1,7 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc
+.DS_Store
+spec/debug.log

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,13 @@
+rvm:
+  - 1.8.7 # (current default)
+  - 1.9.2
+before_script:
+  - "psql -c 'create database birthday_plugin_test;' -U postgres"
+  - "mysql -e 'create database birthday_plugin_test;'"
+  - "gem install rails -v 3.0.9"
+  - "gem install rails -v 2.3.8"
+env:
+  - DB=mysql RAILS=3.0.9
+  - DB=postgres RAILS=3.0.9
+  - DB=mysql RAILS=2.3.8
+  - DB=postgres RAILS=2.3.8

data/Gemfile

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

data/README.md

@@ -0,0 +1,58 @@
+# Birthday
+
+This is a small gem that hooks into ActiveRecord and allows to tag a database field (date or datetime) as birthday, allowing to find birthdays with ease.
+
+## How To Install
+
+After the gem has been properly tested, it will be released on RubyGems, and will be available to be installed with:
+
+    gem install birthday
+
+## Synopsis
+
+Read [a blog post about the gem](http://blog.railslove.com/2011/10/17/birthday-gem-easy-anniversaries-handling-ruby/) at Railslove blog to get a comprehensive guide to usage of this gem.
+
+### To do
+
+* Test PostgreSQL
+* kick class_eval?
+* make tests more "aware" of environment
+
+## Note on Patches/Pull Requests
+
+* Fork the project.
+* Create a feature branch
+* Make your feature addition or bug fix.
+* Add tests.
+* Commit, do not mess with Rakefile, version, or history.
+* Send me a pull request.
+
+## Copyright
+
+Copyright (c) 2011 Railslove
+
+## Main contributors
+
+* [@Holek (Mike Połtyn)](http://github.com/Holek)
+
+## License
+
+The 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/RUNNING_UNIT_TESTS

@@ -0,0 +1,9 @@
+1. Pick Rails version.  Either dump this plugin in a Rails app and run it from there, or specify it as an ENV var:
+
+  RAILS=3.0.9 rspec spec/birthday_spec.rb
+
+2. Setup your database.  By default mysql is used, and no further setup is necessary.  You can pick any of the listed databases in test/database.yml.  Be sure to create the database first.
+
+  DB=postgres rspec spec/birthday_spec.rb
+
+3. Profit!!

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler'
+require 'rspec/core/rake_task'
+
+Bundler::GemHelper.install_tasks
+
+desc "Run specs"
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/birthday.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "railslove/acts/birthday/version"
+
+Gem::Specification.new do |s|
+  s.name        = "birthday"
+  s.version     = Railslove::Acts::Birthday::VERSION
+  s.authors     = ["Mike Połtyn"]
+  s.email       = ["mike@railslove.com"]
+  s.homepage    = ""
+  s.summary     = %q{Birthday gem allows to tag date and datetime fields in ActiveRecord}
+  s.description = %q{Birthday gem creates convienent methods for date and datetime fields in ActiveRecord, making it possible to look for birthdays without a hassle.}
+
+  s.rubyforge_project = "birthday"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rake"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "mysql2", '0.3.6'
+  s.add_development_dependency "delorean"
+  s.add_development_dependency "pg"
+  s.add_runtime_dependency "activerecord"
+  s.add_runtime_dependency "activesupport"
+end

data/lib/birthday.rb

@@ -0,0 +1,7 @@
+require "railslove/acts/birthday/birthday"
+require "railslove/acts/birthday/adapters/mysql_adapter"
+require "railslove/acts/birthday/adapters/mysql2_adapter"
+require "railslove/acts/birthday/adapters/postgresql_adapter"
+require "railslove/acts/birthday/version"
+
+ActiveRecord::Base.send :include, ::Railslove::Acts::Birthday

data/lib/railslove/acts/birthday/adapters/mysql2_adapter.rb

@@ -0,0 +1,11 @@
+# Birthday
+module Railslove
+  module Acts #:nodoc:
+    module Birthday #:nodoc:
+      module Adapters
+        class Mysql2Adapter < MysqlAdapter
+        end
+      end
+    end
+  end
+end

data/lib/railslove/acts/birthday/adapters/mysql_adapter.rb

@@ -0,0 +1,28 @@
+# Birthday
+module Railslove
+  module Acts #:nodoc:
+    module Birthday #:nodoc:
+      module Adapters
+        class MysqlAdapter
+          def self.scope_hash(field, date_start, date_end)
+            date_start = date_start.to_date
+            if ((date_end.respond_to?(:empty?) && date_end.empty?) || !date_end)
+              where_sql = "DATE_FORMAT(`#{field}`, '%m%d') = \"#{date_start.strftime('%m%d')}\""
+            else
+              date_end = date_end.to_date
+              if date_end.strftime('%m%d') < date_start.strftime('%m%d')
+                where_sql = "(DATE_FORMAT(`#{field}`, '%m%d') >= \"0101\""
+                where_sql << " AND DATE_FORMAT(`#{field}`, '%m%d') <= \"#{date_start.strftime('%m%d')}\")"
+                where_sql << " OR (DATE_FORMAT(`#{field}`, '%m%d') >= \"#{date_end.strftime('%m%d')}\""
+                where_sql << " AND DATE_FORMAT(`#{field}`, '%m%d') <= \"1231\")"
+              else
+                where_sql = "DATE_FORMAT(`#{field}`, '%m%d') >= \"#{date_start.strftime('%m%d')}\" AND DATE_FORMAT(`#{field}`, '%m%d') <= \"#{date_end.strftime('%m%d')}\""
+              end
+            end
+            { :conditions => where_sql }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/railslove/acts/birthday/adapters/postgresql_adapter.rb

@@ -0,0 +1,26 @@
+# Birthday
+module Railslove
+  module Acts #:nodoc:
+    module Birthday #:nodoc:
+      module Adapters
+        class PostgreSQLAdapter
+          def self.scope_hash(field, date_start, date_end)
+            date_start = date_start.to_date
+            if ((date_end.respond_to?(:empty?) && date_end.empty?) || !date_end)
+              where_sql = "to_char(\"#{field}\", 'MMDD') = '#{date_start.strftime('%m%d')}'"
+            else
+              date_end = date_end.to_date
+              if date_end.strftime('%m%d') < date_start.strftime('%m%d')
+                where_sql = "to_char(\"#{field}\", 'MMDD') BETWEEN '0101' AND '#{date_end.strftime('%m%d')}'"
+                where_sql << "OR to_char(\"#{field}\", 'MMDD') BETWEEN '#{date_start.strftime('%m%d')}' AND '1231'"
+              else
+                where_sql = "to_char(\"#{field}\", 'MMDD') BETWEEN '#{date_start.strftime('%m%d')}' AND '#{date_end.strftime('%m%d')}'"
+              end
+            end
+            { :conditions => where_sql }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/railslove/acts/birthday/birthday.rb

@@ -0,0 +1,76 @@
+# Birthday
+module Railslove
+  module Acts #:nodoc:
+    module Birthday #:nodoc:
+      def self.included(base)
+        base.extend ClassMethods
+      end
+
+      module ClassMethods
+
+        # Expects an array of date or datetime fields. If the first object
+        # in passed array is a class with a class method `scope_hash`
+        #   class SqliteAdapter
+        #     def self.scope_hash(field, date_start, date_end)
+        #       # do some magic and return scope hash you can use
+        #     end
+        #   end
+        # 
+        # then this class is used as an adapter to create its scope for birthday finders.
+        #
+        # An example code in basic model would be:
+        #
+        #   class Person < ActiveRecord::Base
+        #     acts_as_birthday :birthday, :created_at
+        #   end
+        #
+        # This will create scopes:
+        #   Person.find_birthdays_for
+        #   Person.find_created_ats_for
+        # and instance methods:
+        #   person = Person.find(1)
+        #   person.birthday_age => 34
+        #   person.birthday_today? => true/false
+        #   person.created_at_age => 2
+        #   person.created_at_today? => true/false
+        def acts_as_birthday(*args)
+          args = args.to_a.flatten.compact
+          klass = args.shift if args.first.class == Class
+          if klass && klass.class == Class
+            @@_birthday_backend = klass
+          else
+            @@_birthday_backend ||= "Railslove::Acts::Birthday::Adapters::#{ActiveRecord::Base.connection.class.name.split("::").last}".constantize
+          end
+          
+          birthday_fields = args.map(&:to_sym)
+
+          scope_method = ActiveRecord::VERSION::MAJOR == 3 ? 'scope' : 'named_scope'
+
+          birthday_fields.each do |field|
+            self.send(scope_method, :"find_#{field.to_s.pluralize}_for", lambda{ |*scope_args|
+              raise ArgumentError if scope_args.empty? or scope_args.size > 2
+              date_start, date_end = *scope_args
+              @@_birthday_backend.scope_hash(field, date_start, date_end)
+            })
+
+            class_eval %{
+              def #{field}_age
+                return nil unless self.#{field}?
+                today = Date.today
+                age = today.year - #{field}.year
+                age -= 1 if today.month < #{field}.month || (today.month == #{field}.month && today.mday < #{field}.mday)
+                age
+              end
+
+              def #{field}_today?
+                return nil unless self.#{field}?
+                Date.today.strftime('%m%d') == #{field}.strftime('%m%d')
+              end
+            }
+          end
+        end
+      end
+
+    end
+  end
+end

data/lib/railslove/acts/birthday/version.rb

@@ -0,0 +1,7 @@
+module Railslove
+  module Acts
+    module Birthday
+      VERSION = "0.0.1"
+    end
+  end
+end

data/spec/birthday_spec.rb

@@ -0,0 +1,95 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+class Person < ActiveRecord::Base
+  acts_as_birthday :birthday
+end
+
+class Marriage < ActiveRecord::Base
+  acts_as_birthday :anniversary
+end
+
+describe Marriage do
+
+  before :each do
+    @m1 = Marriage.create(:faithful => true,  :anniversary => Date.parse('2009-09-09')).reload
+    @m2 = Marriage.create(:faithful => false, :anniversary => Date.parse('2009-08-08')).reload
+  end
+
+  after :each do
+    back_to_the_present
+  end
+
+  it 'check anniversary_today? correctly' do
+    time_travel_to Date.parse('2011-09-09')
+    @m1.should be_anniversary_today
+    @m2.should_not be_anniversary_today
+  end
+
+  it 'check anniversary_age correctly' do
+    time_travel_to Date.parse('2011-09-08')
+    @m1.anniversary_age.should eq(1)
+    @m2.anniversary_age.should eq(2)
+  end
+  
+  it 'finds people\'s by anniversary date' do
+    time_travel_to Date.parse('2011-08-08')
+    anniversaries_today = Marriage.find_anniversaries_for(Date.today)
+    anniversaries_today.should_not include(@m1)
+    anniversaries_today.should include(@m2)
+  end
+
+  it 'finds people\'s by anniversary dates' do
+    anniversaries = Marriage.find_anniversaries_for(Date.parse('2011-08-01'), Date.parse('2011-12-12'))
+    anniversaries.should include(@m1)
+    anniversaries.should include(@m2)
+  end
+
+  it 'finds people\'s by anniversary dates with years overlapping' do
+    anniversaries = Marriage.find_anniversaries_for(Date.parse('2011-09-01'), Date.parse('2012-08-12'))
+    anniversaries.should include(@m1)
+    anniversaries.should include(@m2)
+  end
+end
+
+describe Person do
+
+  before :each do
+    @p1 = Person.create(:name => "Twilight Sparkle", :birthday => Date.parse('2006-09-09')).reload
+    @p2 = Person.create(:name => "Rainbow Dash",     :birthday => Date.parse('2004-08-08')).reload
+  end
+
+  after :each do
+    back_to_the_present
+  end
+
+  it 'check birthday_today? correctly' do
+    time_travel_to Date.parse('2011-09-09')
+    @p1.should be_birthday_today
+    @p2.should_not be_birthday_today
+  end
+
+  it 'check birthday_age correctly' do
+    time_travel_to Date.parse('2011-09-08')
+    @p1.birthday_age.should eq(4)
+    @p2.birthday_age.should eq(7)
+  end
+  
+  it 'finds people\'s by birthday date' do
+    time_travel_to Date.parse('2011-08-08')
+    birthdays_today = Person.find_birthdays_for(Date.today)
+    birthdays_today.should_not include(@p1)
+    birthdays_today.should include(@p2)
+  end
+
+  it 'finds people\'s by birthday dates' do
+    birthdays = Person.find_birthdays_for(Date.parse('2011-08-01'), Date.parse('2011-12-12'))
+    birthdays.should include(@p1)
+    birthdays.should include(@p2)
+  end
+
+  it 'finds people\'s by birthday dates with years overlapping' do
+    birthdays = Person.find_birthdays_for(Date.parse('2011-09-01'), Date.parse('2012-08-12'))
+    birthdays.should include(@p1)
+    birthdays.should include(@p2)
+  end
+end

data/spec/database.yml

@@ -0,0 +1,9 @@
+mysql:
+  adapter: mysql2
+  database: birthday_plugin_test
+  username: 
+  encoding: utf8
+postgres:
+  adapter: postgresql
+  database: birthday_plugin_test
+  username: postgres

data/spec/schema.rb

@@ -0,0 +1,13 @@
+ActiveRecord::Schema.define(:version => 1) do
+
+  create_table :people, :force => true do |t|
+    t.column :name, :string
+    t.column :birthday, :date
+  end
+
+  create_table :marriages, :force => true do |t|
+    t.column :faithful, :boolean
+    t.column :anniversary, :datetime
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,50 @@
+$:.unshift(File.dirname(__FILE__))
+$:.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'test/unit'
+require 'rubygems'
+require 'rspec'
+
+def fixture(file_name)
+  File.read(fixture_path(file_name))
+end
+
+def fixture_path(file_name)
+  File.expand_path(File.dirname(__FILE__)) + "/fixtures/#{file_name}"
+end
+
+if ENV['RAILS'].nil?
+  require File.expand_path(File.join(File.dirname(__FILE__), '../../../../config/environment.rb'))
+else
+  # specific rails version targeted
+  # load activerecord and activesupport and plugin manually
+  require 'active_record'
+  require 'active_support'
+  $LOAD_PATH << File.join(File.dirname(__FILE__), '..', 'lib')
+  Dir["#{$LOAD_PATH.last}/**/*.rb"].each do |path| 
+    require path[$LOAD_PATH.last.size + 1..-1]
+  end
+  require "railslove/acts/birthday/birthday"
+end
+require 'delorean'
+require 'yaml'
+config = YAML::load(IO.read(File.dirname(__FILE__) + '/database.yml'))
+adapter = ENV['DB'] || 'mysql'
+case adapter
+when 'mysql'
+  require 'mysql2'
+when 'postgres'
+  require 'pg'
+else
+  require adapter
+end
+
+ActiveRecord::Base.configurations.update config
+ActiveRecord::Base.establish_connection(adapter)
+ActiveRecord::Base.default_timezone = :utc
+
+load(File.dirname(__FILE__) + "/schema.rb")
+
+RSpec.configure do |config|
+  config.include Delorean
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification 
+name: birthday
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Mike Po\xC5\x82tyn"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-10-28 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mysql2
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 31
+        segments: 
+        - 0
+        - 3
+        - 6
+        version: 0.3.6
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: delorean
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: pg
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id007
+description: Birthday gem creates convienent methods for date and datetime fields in ActiveRecord, making it possible to look for birthdays without a hassle.
+email: 
+- mike@railslove.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- RUNNING_UNIT_TESTS
+- Rakefile
+- birthday.gemspec
+- lib/birthday.rb
+- lib/railslove/acts/birthday/adapters/mysql2_adapter.rb
+- lib/railslove/acts/birthday/adapters/mysql_adapter.rb
+- lib/railslove/acts/birthday/adapters/postgresql_adapter.rb
+- lib/railslove/acts/birthday/birthday.rb
+- lib/railslove/acts/birthday/version.rb
+- spec/birthday_spec.rb
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: birthday
+rubygems_version: 1.8.6
+signing_key: 
+specification_version: 3
+summary: Birthday gem allows to tag date and datetime fields in ActiveRecord
+test_files: 
+- spec/birthday_spec.rb
+- spec/database.yml
+- spec/schema.rb
+- spec/spec_helper.rb
+has_rdoc: