timeframeable 0.0.1

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 timeframeable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexander Pavlenko
+
+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,44 @@
+# Timeframeable
+
+Timeframeable module allows you to easily extract datetime range from request params keeping you controllers DRY.
+Intended to use with Rails 3, but may be compatible or easily adaptable with/to other versions.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'timeframeable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install timeframeable
+
+## Usage
+
+Inject dates from ```params[:start]``` and ```params[:end]``` or their default values into ```@timeframe.start``` and ```@timeframe.end```:
+
+    timeframeable :defaults => [:beginning_of_month, :now]
+
+Inject dates from ```params[:s]``` and ```params[:e]``` or their default values into ```@timeframe.start``` and ```@timeframe.end```:
+
+    timeframeable :defaults => [:beginning_of_month, :now], :start_key => :s, :end_key => :e
+
+Inject dates from ```params[:start]``` and ```params[:end]``` or their default values into ```@timeframe.start``` and ```@timeframe.end```, and inject dates from ```params[:s]``` and ```params[:e]``` or their default values into ```@tf.start``` and ```@tf.end```:
+
+    timeframeable :defaults => [:beginning_of_month, :now]
+    timeframeable :defaults => [:beginning_of_month, :now], :start_key => :s, :end_key => :e, :variable => :'@tf'
+
+## TODO
+If there will be such a need, it may be usefull to add ```:start_value``` and ```:end_value``` lambda options, which will extract appropriate values from ```params``` bypassing ```:start_key``` and ```:end_key```.
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/timeframeable.rb

@@ -0,0 +1,92 @@
+require 'timeframeable/version'
+require 'active_support/concern'
+require 'date'
+require 'active_support/core_ext/date/calculations'
+require 'active_support/core_ext/date/conversions'
+require 'active_support/core_ext/time/calculations'
+require 'active_support/core_ext/date_time/calculations'
+require 'active_support/core_ext/date_time/conversions'
+
+module Timeframeable
+  extend ActiveSupport::Concern
+
+  Timeframe = Struct.new(:start, :end)
+
+  module ClassMethods
+    def timeframeable(options={})
+      raise 'Timeframe defaults not defined' if options[:defaults].blank?
+      raise 'Invalid Timeframe defaults' unless options[:defaults].size == 2
+
+      options = options.dup
+
+      options[:start_key] ||= :start
+      options[:end_key]   ||= :end
+      options[:variable]  ||= :'@timeframe'
+      options[:defaults] = options[:defaults].map do |x|
+        if x.is_a? Symbol
+          if x == :now
+            DateTime.now
+          else
+            DateTime.now.send(x)
+          end
+        else
+          x
+        end
+      end
+
+      before_filter do
+        set_timeframe options
+      end
+    end
+  end
+
+  def self.parse_date(param, extrapolate=nil)
+    return unless param
+
+    if param.kind_of? Hash
+      parts = [:year, :month, :day].map do |key|
+        value = param[key].to_i
+        if value == 0
+          value = case key
+            when :year
+              Date.today.year
+            else
+              1
+          end
+        end
+        value
+      end
+
+      begin
+        result = DateTime.new(*parts)
+      rescue
+        return
+      end
+
+      case extrapolate
+        when :end
+          if param[:day].to_i == 0
+            result = result.end_of_month
+          end
+          result = result.end_of_day
+        else
+      end
+
+      result
+    else
+      begin
+        DateTime.parse(param.to_s)
+      rescue
+        return
+      end
+    end
+  end
+
+private
+
+  def set_timeframe(options)
+    start_date = Timeframeable.parse_date(params[options[:start_key]]) || options[:defaults][0].to_datetime
+    end_date   = Timeframeable.parse_date(params[options[:end_key]], :end) || options[:defaults][1].to_datetime
+    instance_variable_set options[:variable], Timeframe.new(start_date.utc, end_date.utc)
+  end
+end

data/lib/timeframeable/version.rb

@@ -0,0 +1,3 @@
+module Timeframeable
+  VERSION = '0.0.1'
+end

data/spec/lib/timeframeable_spec.rb

@@ -0,0 +1,111 @@
+require_relative '../spec_helper'
+require 'timeframeable'
+require 'timecop'
+
+describe Timeframeable do
+
+  it 'has dedicated data structure' do
+    data = Timeframeable::Timeframe.new(1, 2)
+    data.start.should == 1
+    data.end.should   == 2
+  end
+
+  describe 'Timeframeable.parse_date' do
+
+    it 'uses DateTime.parse for strings' do
+      data = DateTime.now.change(:usec => 0)
+      Timeframeable.parse_date(data.to_s).should == data
+    end
+
+    it 'suppress exceptions on invalid strings' do
+      Timeframeable.parse_date('trololo').should be_nil
+    end
+
+    it 'accepts composite param' do
+      Timeframeable.parse_date({:year => 2013, :month => 1, :day => 15}).should == DateTime.new(2013, 1, 15)
+    end
+
+    it 'extrapolates range to its end' do
+      Timeframeable.parse_date({:year => 2013, :month => 1, :day => 15}, :end).should == DateTime.new(2013, 1, 15).end_of_day
+      Timeframeable.parse_date({:year => 2013, :month => 1}, :end).should == DateTime.new(2013, 1, 1).end_of_month.end_of_day
+    end
+  end
+
+  context 'controller' do
+    let(:controller) { Class.new.new }
+    let(:default_options) {
+      {
+        :start_key => :start,
+        :end_key => :end,
+        :variable => :'@timeframe',
+        :defaults => [DateTime.now.beginning_of_month, DateTime.now]
+      }
+    }
+
+    before do
+      controller.class.class_eval do
+        include Timeframeable
+      end
+    end
+
+    describe 'Controller.timeframeable' do
+
+      before do
+        mock(controller.class).before_filter() {|block| controller.instance_eval(&block) }
+      end
+
+      it 'timeframes with default options' do
+        options_given = {:defaults => default_options[:defaults]}
+        options_got = default_options
+        mock(controller).set_timeframe(options_got)
+        controller.class.timeframeable(options_given)
+      end
+
+      it 'timeframes with symbol options' do
+        Timecop.freeze(DateTime.now) do
+          options_given = {:defaults => [:beginning_of_month, :now]}
+          options_got = default_options.merge(:defaults => [DateTime.now.beginning_of_month, DateTime.now])
+          mock(controller).set_timeframe(options_got)
+          controller.class.timeframeable(options_given)
+        end
+      end
+
+      it 'timeframes with custom options' do
+        Timecop.freeze(DateTime.now) do
+          options_given = {:defaults => [:beginning_of_month, :now], :start_key => :s, :end_key => :e, :variable => :'@tf'}
+          options_got = default_options.merge(options_given).merge(:defaults => [DateTime.now.beginning_of_month, DateTime.now])
+          mock(controller).set_timeframe(options_got)
+          controller.class.timeframeable(options_given)
+        end
+      end
+    end
+
+    describe 'Controller#set_timeframe' do
+      it 'falls back to default values' do
+        stub(controller).params{ {} }
+        controller.send :set_timeframe, default_options
+        controller.instance_variable_get(default_options[:variable]).should ==
+          Timeframeable::Timeframe.new(*default_options[:defaults])
+      end
+
+      it 'uses actual params' do
+        dates = default_options[:defaults].map{|d| d.prev_month.utc.change(:usec => 0) }
+        stub(controller).params{ Hash[[:start, :end].zip(dates.map(&:to_s))] }
+        controller.send :set_timeframe, default_options
+        controller.instance_variable_get(default_options[:variable]).should ==
+          Timeframeable::Timeframe.new(*dates)
+      end
+
+      it 'allows multiple timeframes to be set' do
+        stub(controller).params{ {} }
+        other_options = default_options.merge(:variable => :'@test', :defaults => default_options[:defaults].map(&:prev_month))
+        controller.send :set_timeframe, default_options
+        controller.send :set_timeframe, other_options
+        controller.instance_variable_get(default_options[:variable]).should ==
+          Timeframeable::Timeframe.new(*default_options[:defaults])
+        controller.instance_variable_get(other_options[:variable]).should ==
+          Timeframeable::Timeframe.new(*other_options[:defaults])
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.mock_with :rr
+end

data/timeframeable.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'timeframeable/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'timeframeable'
+  gem.version       = Timeframeable::VERSION
+  gem.authors       = ['AlexanderPavlenko']
+  gem.email         = ['a.pavlenko@roundlake.ru']
+  gem.description   = %q{controller module for extracting datetime range from request params}
+  gem.summary       = %q{datetime range extractor}
+  gem.homepage      = ''
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_dependency 'activesupport'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'rr'
+  gem.add_development_dependency 'timecop'
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: timeframeable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- AlexanderPavlenko
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: controller module for extracting datetime range from request params
+email:
+- a.pavlenko@roundlake.ru
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/timeframeable.rb
+- lib/timeframeable/version.rb
+- spec/lib/timeframeable_spec.rb
+- spec/spec_helper.rb
+- timeframeable.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+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.24
+signing_key: 
+specification_version: 3
+summary: datetime range extractor
+test_files:
+- spec/lib/timeframeable_spec.rb
+- spec/spec_helper.rb
+has_rdoc: