rails_agnostic_models 0.0.3 → 0.0.4

data/README.md

@@ -31,7 +31,8 @@ class MyModel < ActiveRecord::Base
   rails_3 { audited }
 
   # scoping, named_scope in Rails 2, scope in Rails 3+
-  version_agnostic_scope :active, { where active: true } # relies on fake_arel in Rails 2 to provide 3+ Query Interface
+  # We recommend using FakeArel in Rails 2 projects to get a universal query interface, but it is not required
+  version_agnostic_scope :active, { where active: true }
 
   # single table inheritance, set_inheritance_column in rails 2, self.inheritance_column= in Rails 3+
   version_agnostic_inheritance_column "type_inheritance"

data/lib/rails_agnostic_models/active_record_extensions.rb

@@ -1,16 +1,25 @@
 module RailsAgnosticModels
   module ActiveRecordExtensions
     module ClassMethods
+
+      # Checks if the host app is a Rails 2 app
       def rails_2?
-        (defined? Rails) && (Rails::VERSION::MAJOR == 2)
+        rails_loaded && (Rails::VERSION::MAJOR == 2)
       end
 
+      # Checks if the host app is a Rails 3 app
       def rails_3?
-        (defined? Rails) && (Rails::VERSION::MAJOR == 3)
+        rails_loaded && (Rails::VERSION::MAJOR == 3)
       end
 
+      # Checks if the host app is a Rails 4 app
       def rails_4?
-        (defined? Rails) && (Rails::VERSION::MAJOR == 4)
+        rails_loaded && (Rails::VERSION::MAJOR == 4)
+      end
+
+      # Checks if Rails is loaded
+      def rails_loaded
+        defined? Rails
       end
 
       # Takes a block that will only be executed in a Rails 2 Project
@@ -19,16 +28,25 @@ module RailsAgnosticModels
         yield
       end
 
+      # Code to be executed insode of a Rails 3 app
       def rails_3(&block)
         return nil unless rails_3?
         yield
       end
 
+      # Code to be executed inside of a Rails 4 app
       def rails_4(&block)
         return nil unless rails_4?
         yield
       end
 
+      # Code to be executed only inside of a rails app 
+      def rails(&block)
+        return nil unless rails_loaded
+        yield
+      end
+
+      # Defines the appropraite scope based on the version of Rails
       def version_agnostic_scope(*args)
         if rails_2?
           named_scope(*args)
@@ -37,6 +55,7 @@ module RailsAgnosticModels
         end
       end
 
+      # Sets the inheritance column based on the version of Rails
       def version_agnostic_inheritance_column(column_name)
         if rails_2?
           set_inheritance_column column_name
@@ -50,4 +69,4 @@ module RailsAgnosticModels
     end
   end
   ActiveRecord::Base.send(:include, ActiveRecordExtensions)
-end
+end

data/lib/rails_agnostic_models/version.rb

@@ -1,3 +1,3 @@
 module RailsAgnosticModels
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails_agnostic_models
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-06 00:00:00.000000000 Z
+date: 2014-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -92,7 +92,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 223464881747250287
+      hash: 1843333470422886331
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 223464881747250287
+      hash: 1843333470422886331
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24