blazy 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,41 +1,72 @@
 == Description
 
-Blazy read as be_lazy is a handy extension to active record models meant to be used in script/console
+Blazy(be lazy) is a fluent extension to active record models to reduce number of key strokes in script/console.
 
-== Install
+Currently works with rails 2.2.x and 2.3.x
 
-Install the gem with:
+== Install
 
-    sudo gem install blazy   #Note: If you are using rvm to manage ruby versions don't use sudo
+	gem install blazy
 
 == Usage
 
 Go to script/console in your rails project and type
 
-require 'blazy'
+	require 'blazy'
 
 you are ready to go!!
 
+== How does it help me?
+
+Most of the operations we do in script/console while debugging a problem or looking for model values in database take a lot of key strokes. Blazy provides methods, aliases and a fluent interface to reduce the number of keystrokes to bare minimal.
+
 == Examples
+Lets say you have a active record model called Project.
+
+This is what being lazy means
+
+	Project.find(11)     -->  Project-11 or Project[11]  # [id] is preferred
+	Project.all          -->  projects
+	Project.first        -->  project
+
+When you want to see some subset of data
 
-If you have a model Project.
+	Project.all(:limit => 10)  --> 10.projects
+	Project.first              --> 1.project
 
-	1.project or 2.projects to list projects
+Scopes generated for each column
 
-	Project-11 to get project with id 11
+	Project.all(:conditions => {:name => 'blazy' })  --> Project.with_name('blazy') # you get autocomplete for this
 
-== Work in progress
+And its fluency using named scope (more like rails 3 way)
 
-	Searching a project as
+	Project.all(:conditions =>....)                   --> Project.where(..) or Project.with()
+	Project.all(:limit => 10)                         --> Project.limit(10)
+	Project.all(:order => 'name DESC')                --> Project.order('name DESC')
+	Project.all(:select => 'name')                    --> Project.select('name')
+	Project.all(:conditions => ["name like '%lazy'"]) --> Project.where("name like '%lazy'")  #can also use 'with' instead of 'where'
 
-	Project.with_name('blazy') or 5.projects.with_name_like('%zy')
+And the power comes by chaining them
 
-	Chaining
+	10.projects.with('priority < 2').order(:priority)
 
-	5.projects.with_priority(3..5).not_completed
+	Project.with_priority(1).limit 10
+
+Lastly and actually the least some aliases. These are useful at the end of scope to inspect a model
+
+	Project.with_priority(1).f.name
+
+	Listing them --> f => first, l => last, a => all
+
+== To do
+
+	models     - to list all models in the project
+	relations  - to show quick summary of a model's associations
 
 == Other useful gems in script/console
 
-Wirble
+Wirble[http://github.com/blackwinter/wirble]
+
+Hirb[http://github.com/cldwalker/hirb]
 
-Hirb
+and add this[http://gist.github.com/609341] to your ~/.irbc

data/Rakefile

@@ -13,9 +13,9 @@ task :default => ["spec"]
 
 spec = Gem::Specification.new do |s|
   s.name              = "blazy"
-  s.version           = "0.1.1"
-  s.summary           = "Provides fluent extension to active record models"
-  s.description       = "Blazy read as be_lazy is a fluent extension to active record models and meant only to be used in script/console"
+  s.version           = "0.1.2"
+  s.summary           = "Provides fluent extensions and aliases to active record models"
+  s.description       = "Blazy(be lazy) is a fluent extension to active record models to reduce number of key strokes in script/console"
   s.author            = "Deepak N"
   s.email             = "endeep123@gmail.com"
   s.homepage          = "http://github.com/endeepak/blazy"
@@ -24,10 +24,10 @@ spec = Gem::Specification.new do |s|
   s.rdoc_options      = %w(--main README.rdoc)
   s.files             = %w(Rakefile README.rdoc) + Dir.glob("{spec,lib/**/*}")
   s.require_paths     = ["lib"]
-  s.add_development_dependency('rspec')
-  s.add_development_dependency('activerecord')
-  s.add_development_dependency('active_support')
-  s.add_development_dependency('factory_girl')
+  s.add_development_dependency('rspec', '= 1.3.0')
+  s.add_development_dependency('activerecord', '= 2.3.5')
+  s.add_development_dependency('active_support', '= 2.3.5')
+  s.add_development_dependency('factory_girl', '= 1.2.4')
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|
@@ -62,3 +62,14 @@ desc 'Clear out RDoc and generated packages'
 task :clean => [:clobber_rdoc, :clobber_package] do
   rm "#{spec.name}.gemspec"
 end
+
+namespace :db do
+  namespace :mysql do
+    desc 'Recreates test database in mysql server'
+    task  :recreate do
+      `mysql -uroot -e "drop database if exists blazy_test"`
+      `mysql -uroot -e "create database if not exists blazy_test"`
+      `mysql -uroot -D blazy_test -e "show tables"`
+    end
+  end
+end

data/lib/blazy.rb

@@ -2,7 +2,8 @@ require 'rubygems'
 require 'active_record'
 require 'active_support/inflector'
 
-require 'extensions/active_model'
+require 'extensions/object'
 require 'extensions/active_record'
 
+#HACKTAG:: Load all model from rails app model instead of lazy load  - Testing this?
 Dir.glob(File.join(RAILS_ROOT,'app','models','**','*.rb')).each { |file| require_dependency file } if defined?(RAILS_ROOT)

data/lib/extensions/active_record.rb

@@ -1,3 +1,18 @@
-require File.dirname(__FILE__) + '/active_record/fixnum'
+class ActiveRecord::Base
+  named_scope :with, lambda { |conditions| {:conditions => conditions } }
+  named_scope :limit, lambda { |limit| {:limit => limit} }
+  named_scope :order, lambda { |order| {:order => order} }
+  named_scope :select, lambda { |*columns| {:select => columns} }
 
+  class << self
+    {:where => :with, :-  => :find, :[]  => :find, :f => :first, :a => :all, :l => :last}.each do |new_name, method|
+      eval "alias #{new_name} #{method}"
+    end
+  end
+end
+
+Dir.glob(File.join(File.dirname(__FILE__),'active_record','*.rb')).each { |file| require file }
+ActiveRecord::Base.send(:include, Blazy::Extensions::ActiveRecord::ScopeMerge)
+ActiveRecord::Base.send(:include, Blazy::Extensions::ActiveRecord::Object)
 ActiveRecord::Base.send(:include, Blazy::Extensions::ActiveRecord::Fixnum)
+ActiveRecord::Base.send(:include, Blazy::Extensions::ActiveRecord::ColumnScope)

data/lib/extensions/active_record/column_scope.rb

@@ -0,0 +1,27 @@
+module Blazy
+  module Extensions
+    module ActiveRecord
+      module ColumnScope
+        def self.included(klass)
+          klass.extend ClassMethods
+          klass.send(:subclasses).each {|subclass| subclass.add_column_scope unless subclass.abstract_class?}
+        end
+
+        module ClassMethods
+          def inherited(klass)
+            super
+            klass.add_column_scope
+          end
+
+          def add_column_scope
+            self.columns.each do |column|
+              self.named_scope "with_#{column.name}", lambda { |*params| {:conditions => { column.name => params } } }
+            end
+          rescue ::ActiveRecord::ActiveRecordError => e
+            puts "Failed to add column scope for #{self.name} : #{e.message}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/extensions/active_record/fixnum.rb

@@ -14,22 +14,18 @@ module Blazy
           end
 
           def add_extension_to_fixnum
-            underscored_model_name = self.name.demodulize.underscore
-            pluralized_underscored_model_name = underscored_model_name.pluralize
-            definition = <<-METHOD_DEFINITION
-                              class ::Fixnum
-                                def #{underscored_model_name}
-                                  record_to_find = self==1 ? :first : :all
-                                  #{self}.find(record_to_find, :limit => self)
-                                end
-                                alias #{pluralized_underscored_model_name} #{underscored_model_name}
-                              end
-                          METHOD_DEFINITION
-            eval(definition)
+            eval <<-METHOD
+                    class ::Fixnum
+                      def #{self.singular_name}
+                        #{self}.limit(self)
+                      end
+                      alias #{self.plural_name} #{self.singular_name}
+                    end
+                METHOD
           end
         end
       end
-      
+
     end
   end
 end

data/lib/extensions/active_record/object.rb

@@ -0,0 +1,36 @@
+module Blazy
+  module Extensions
+    module ActiveRecord
+      module Object
+        def self.included(klass)
+          klass.extend ClassMethods
+          klass.send(:subclasses).each {|subclass| subclass.add_extension_to_object}
+        end
+
+        module ClassMethods
+          def inherited(klass)
+            super
+            klass.add_extension_to_object
+          end
+
+          def add_extension_to_object
+            eval <<-METHOD
+                      class ::Object
+                        def #{self.singular_name}
+                          #{self}.first
+                        end
+                      end
+                    METHOD
+            eval <<-METHOD
+                      class ::Object
+                        def #{self.plural_name}
+                          #{self}.all
+                        end
+                      end
+                    METHOD
+          end
+        end
+      end
+    end
+  end
+end

data/lib/extensions/active_record/scope_merge.rb

@@ -0,0 +1,11 @@
+module Blazy
+  module Extensions
+    module ActiveRecord
+      module ScopeMerge
+        def self.included(klass)
+          klass.send(:subclasses).each {|subclass| subclass.scopes.reverse_merge!(klass.scopes) }
+        end
+      end
+    end
+  end
+end

data/lib/extensions/object.rb

@@ -0,0 +1,3 @@
+Dir.glob(File.join(File.dirname(__FILE__),'object','*.rb')).each { |file| require file }
+
+Object.send(:include, Blazy::Extensions::Object::Name)

data/lib/extensions/object/name.rb

@@ -0,0 +1,15 @@
+module Blazy
+  module Extensions
+    module Object
+      module Name
+        def singular_name
+          self.name.demodulize.underscore
+        end
+
+        def plural_name
+          self.singular_name.pluralize
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: blazy
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Deepak N
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-04 00:00:00 +05:30
+date: 2010-10-11 00:00:00 +05:30
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -24,12 +24,14 @@ dependencies:
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 27
         segments: 
+        - 1
+        - 3
         - 0
-        version: "0"
+        version: 1.3.0
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
@@ -38,12 +40,14 @@ dependencies:
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 9
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
   type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
@@ -52,12 +56,14 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 9
         segments: 
-        - 0
-        version: "0"
+        - 2
+        - 3
+        - 5
+        version: 2.3.5
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
@@ -66,15 +72,17 @@ dependencies:
   requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - "="
       - !ruby/object:Gem::Version 
-        hash: 3
+        hash: 23
         segments: 
-        - 0
-        version: "0"
+        - 1
+        - 2
+        - 4
+        version: 1.2.4
   type: :development
   version_requirements: *id004
-description: Blazy read as be_lazy is a fluent extension to active record models and meant only to be used in script/console
+description: Blazy(be lazy) is a fluent extension to active record models to reduce number of key strokes in script/console
 email: endeep123@gmail.com
 executables: []
 
@@ -86,9 +94,13 @@ files:
 - Rakefile
 - README.rdoc
 - lib/blazy.rb
-- lib/extensions/active_model.rb
+- lib/extensions/active_record/column_scope.rb
 - lib/extensions/active_record/fixnum.rb
+- lib/extensions/active_record/object.rb
+- lib/extensions/active_record/scope_merge.rb
 - lib/extensions/active_record.rb
+- lib/extensions/object/name.rb
+- lib/extensions/object.rb
 has_rdoc: true
 homepage: http://github.com/endeepak/blazy
 licenses: []
@@ -123,6 +135,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Provides fluent extension to active record models
+summary: Provides fluent extensions and aliases to active record models
 test_files: []
 

data/lib/extensions/active_model.rb

@@ -1,15 +0,0 @@
-module Blazy
-  module ActiveModel
-    def self.included(klass)
-      klass.extend ClassMethods
-    end
-
-    module ClassMethods
-      def -(id)
-        self.find(id)
-      end
-    end
-  end
-end
-
-ActiveRecord::Base.send(:include, Blazy::ActiveModel)