by_star 0.3.1 → 0.4.0

data/README.markdown

@@ -335,11 +335,27 @@ All methods support this extra option.
 
 ## Scoping the find
 
-All the `by_*` methods takes a block which will then scope the find based on the options passed into it. The supported options are the same options that are supported by `ActiveRecord::Base.find`:
+All the `by_*` methods take a block which will then scope the find based on the options passed into it. You can also specify these options for each method, but the syntax may differ. The supported options are the same options that are supported by `find` from ActiveRecord. Please note that if you want to use conditions you *have* to use this syntax:
+
+     Post.by_month(1) { { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] } }
+
+or the lengthened:
 
      Post.by_month(1) do
        { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] }
      end
+    
+An alternative syntax to this is:
+
+     Post.by_month(1, { :include => "tags", :conditions => ["tags.name = ?", 'ruby'] })
+     
+## Ordering records
+
+To order the returned set of records you may specify an `:order` option which works the same was as a standard AR `:order` option:
+
+     Item.by_month(1, :order => "position DESC")
+
+     
 ## "Chronicable string"
 
 This means a string that can be parsed with the Chronic gem.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/by_star.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{by_star}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ryan Bigg", "Mislav Marohni\304\207"]
-  s.date = %q{2009-10-28}
+  s.date = %q{2009-10-30}
   s.description = %q{ActiveRecord extension for easier date scopes and time ranges}
   s.email = %q{radarlistener@gmail.com}
   s.extra_rdoc_files = [

data/lib/calculations/count.rb

@@ -1,15 +1,20 @@
 module ByStar
   module Calculations
     module Count
-      def count_by_year(field=nil, year=Time.now.year, options={})
-        count(field, :conditions => conditions_for_range(start_of_year(year), end_of_year(year), options))
+      def count_by_year(field=nil, year=Time.now.year, options={}, &block)
+        db_field = options.delete(:field)
+        scoped_by(block) do
+          count(field, { :conditions => conditions_for_range(start_of_year(year), end_of_year(year), db_field) }.reverse_merge!(options))
+        end
       end
       
-      def count_by_month(field=nil, month=Time.now.month, options={})
-        year, month = work_out_month(month, options)
-        count(field, :conditions => conditions_for_range(start_of_month(month, year), end_of_month(month, year), options))
+      def count_by_month(field=nil, month=Time.now.month, options={}, &block)
+        db_field = options.delete(:field)
+        year, month = work_out_month(month, options.delete(:year))
+        scoped_by(block) do
+          count(field, { :conditions => conditions_for_range(start_of_month(month, year), end_of_month(month, year), db_field) }.reverse_merge!(options))
+        end
       end
     end
-    
   end
 end

data/lib/calculations/sum.rb

@@ -1,13 +1,17 @@
 module ByStar
   module Calculations
     module Sum
-      def sum_by_year(field, year=Time.zone.now.year, options={})
-        sum(field, :conditions => conditions_for_range(start_of_year(year), end_of_year(year), options))
+      def sum_by_year(field, year=Time.zone.now.year, options={}, &block)
+        scoped_by(block) do
+          sum(field, { :conditions => conditions_for_range(start_of_year(year), end_of_year(year), options.delete(:field)) }.reverse_merge!(options))
+        end
       end
 
-      def sum_by_month(field, month=Time.zone.now.month, options={})
-        year, month = work_out_month(month, options)
-        sum(field, :conditions => conditions_for_range(start_of_month(month, year), end_of_month(month, year), options))
+      def sum_by_month(field, month=Time.zone.now.month, options={}, &block)
+        year, month = work_out_month(month, options.delete(:year))
+        scoped_by(block) do
+          sum(field, { :conditions => conditions_for_range(start_of_month(month, year), end_of_month(month, year), options.delete(:field)) }.reverse_merge!(options))
+        end
       end
     end
   end

data/lib/calculations.rb

@@ -4,8 +4,8 @@ module ByStar
     include Sum
     
     private
-      def work_out_month(time, options = {})
-        year = options[:year] ||= Time.zone.now.year
+      def work_out_month(time, year=Time.zone.now.year)
+        year ||= Time.zone.now.year
         # Work out what actual month is.
         month = if time.is_a?(Numeric) && (1..12).include?(time)
           time

data/lib/range_calculations.rb

@@ -3,15 +3,15 @@ module ByStar
 
     private
     
-    def start_of_year(year=Time.now.year)
+    def start_of_year(year=Time.zone.now.year)
       Time.utc(year, 1, 1)
     end
     
-    def end_of_year(year=Time.now.year)
+    def end_of_year(year=Time.zone.now.year)
       start_of_year.end_of_year
     end
     
-    def start_of_month(month, year=Time.now.year)
+    def start_of_month(month, year=Timeow.year)
       Time.utc(year, month, 1)
     end
     

data/lib/shared.rb

@@ -1,6 +1,17 @@
 module Shared
-  def conditions_for_range(start_time, end_time, options = {})
-    field = connection.quote_table_name(table_name) << '.' << connection.quote_column_name(options[:field] || "created_at")
+  def conditions_for_range(start_time, end_time, field="created_at")
+    field = connection.quote_table_name(table_name) << '.' << connection.quote_column_name(field || "created_at")
     ["#{field} >= ? AND #{field} <= ?", start_time.utc, end_time.utc]
   end
+  
+  private 
+  def scoped_by(options=nil, &block)
+    if options && scope = options.call
+      with_scope(:find => scope) do
+        block.call
+      end
+    else
+      block.call
+    end
+  end
 end

data/lib/vanilla.rb

@@ -24,7 +24,7 @@ module ByStar
     #   by_month(time)
     def by_month(time=Time.zone.now.month, options={}, &block)
       time = Time.zone.now.month if time.nil?
-      year, month = work_out_month(time, options)
+      year, month = work_out_month(time, options.delete(:year))
   
       start_time = start_of_month(month, year)
       end_time = start_time.end_of_month
@@ -71,7 +71,7 @@ module ByStar
       time = parse(time)
   
       # If options[:year] is passed in, use that year regardless.
-      year = work_out_year(options[:year]) if options[:year]
+      year = work_out_year(options.delete(:year)) if options[:year]
       # If the first argument is a date or time, ask it for the year
       year ||= time.year unless time.is_a?(Numeric)
       # If the first argument is a fixnum, assume this year.
@@ -180,13 +180,11 @@ module ByStar
       
       def by_direction(condition, time, options = {}, &block)
         field = connection.quote_table_name(table_name)
-        field << "." << connection.quote_column_name(options[:field] || "created_at")
-        with_scope(:find => { :conditions => ["#{field} #{condition} ?", time.utc] }) do
-          if block_given?
-            with_scope(:find => block.call) do
-              find(:all)
-            end
-          else
+        field << "." << connection.quote_column_name(options.delete(:field) || "created_at")
+        validate_find_options(options)
+        scoping = { :conditions => ["#{field} #{condition} ?", time.utc] }.merge(options)
+        with_scope(:find => scoping) do
+          scoped_by(block) do
             find(:all)
           end
         end
@@ -198,15 +196,11 @@ module ByStar
         end_time = parse(end_time)
     
         raise ParseError, "End time is before start time, searching like this will return no results." if end_time < start_time
-        order = options.delete(:order)
-        scoping = { :conditions => conditions_for_range(start_time, end_time, options) }
-        scoping.merge!(:order => order) if order
+        field = options.delete(:field)
+        validate_find_options(options)
+        scoping = { :conditions => conditions_for_range(start_time, end_time, field) }.merge(options)
         with_scope(:find => scoping) do
-          if block_given?
-            with_scope(:find => block.call) do
-              find(:all)
-            end
-          else
+          scoped_by(block) do
             find(:all)
           end
         end

data/spec/by_star_spec.rb

@@ -310,6 +310,11 @@ describe Post do
       it "should be able to find all events before Ryan's birthday using a non-standard field" do
         Event.past("04-12-#{Time.zone.now.year}".to_time, :field => "start_time").size.should eql(7)
       end 
+      
+      it "should be able to order the find" do
+        find(Date.today, :order => "created_at ASC").first.text.should eql("Last year")
+        find(Date.today, :order => "created_at DESC").first.text.should eql("post 0")
+      end
     
     end
   
@@ -492,6 +497,15 @@ describe Post do
           { :include => :tags, :conditions => ["tags.name = ?", 'tomorrow'] }
         end.size.should eql(1)
       end
+      
+      it "should work when block is empty" do
+        stub_time
+        Post.future { }.size.should eql(71)
+      end
+      
+      it "should be able to find a single post from the future with the tag 'tomorrow' (redux)" do
+        Post.future(Time.zone.now, :include => :tags, :conditions => ["tags.name = ?", 'tomorrow']).size.should eql(1)
+      end
     
     end
   
@@ -525,6 +539,12 @@ describe Post do
           it "different year" do
             Invoice.count_by_year(:all, 2008)
           end
+          
+          it "current year with the given tag" do
+            Post.count_by_year do
+              { :include => :tags, :conditions => ["tags.name = ?", 'tomorrow'] }
+            end.should eql(1)
+          end
         end
       
         describe "by month" do
@@ -538,7 +558,17 @@ describe Post do
         
           it "different month" do
             stub_time
-            Invoice.count_by_month(:all, 9).should eql(9)
+            Invoice.count_by_month(:all, 9)
+          end
+          
+          it "current month with the given tag" do
+            Post.count_by_month(:all, Time.zone.now) do
+              { :include => :tags, :conditions => ["tags.name = ?", 'tomorrow'] }
+            end.should eql(1)
+          end
+          
+          it "current month with blank block" do
+             Post.count_by_month(:all, Time.zone.now) { }.should eql(16)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: by_star
 version: !ruby/object:Gem::Version 
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors: 
 - Ryan Bigg
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-28 00:00:00 +10:00
+date: 2009-10-30 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency