arusarka-dynamic-active-resource 0.1.6 → 0.1.7

data/README

@@ -74,13 +74,13 @@ end
 To do the same thing, here's how you do it using this library
 
 class Person < DynamicActiveResource::Base
-  module ClassMethods
+  module DynamicClassSingletonMethods
     def count
       find(:all).size
     end
   end
 
-  module InstanceMethods
+  module DynamicClassInstanceMethods
     def occupation
       return job if job
       'Unemployed' 
@@ -88,24 +88,26 @@ class Person < DynamicActiveResource::Base
   end
 end
 
-The instance methods will be available as instance methods in the objects created, class methods
-will be available as class methods in the class of the object. Also active resource associations
-are sometimes paginated. So even if you use find(:all), you get only the first few results. To 
-overcome this, include in your ClassMethods module a method called find_without_pagination. In that
-method route it to acitve resource find with proper parameters. An example of the method implementation
-is 
-
-def find_without_pagination(*args)
-  scope = args.slice!(0)
-  options = args.slice!(0) || {}
-  options[:params] ||= {}
-  options[:params].merge!({:page => 'all'})
-  # call ActiveResource::Base::find with proper options
-  find(scope, options)
+The DynamicClassInstanceMethods will be available as instance methods in the objects created,
+DynamicClassSingletonMethods will be available as class methods in the class of the object. Also
+active resource associations are sometimes paginated. So even if you use find(:all), you get 
+only the first few results. To overcome this, include in your DynamicClassSingletonMethods module
+a method called find_without_pagination. In that method route it to acitve resource find with 
+proper parameters. An example of the method implementation is 
+
+module DynamicClassSingletonMethods
+  def find_without_pagination(*args)
+    scope = args.slice!(0)
+    options = args.slice!(0) || {}
+    options[:params] ||= {}
+    options[:params].merge!({:page => 'all'})
+    # call ActiveResource::Base::find with proper options
+    find(scope, options)
+  end
 end
 
-The class level find method will automatically pick up this method if defined as a ClassMethod method
-else it will pass it to find. 
+The class level find method will automatically pick up this method if defined as a method in the
+DynamicClassSingeletonMethod module else it will pass it to find. 
 
 ASSOCIATIONS
 ------------
@@ -121,13 +123,13 @@ Taking the example from above the way it should be done
 class Person < DynamicActiveResource::Base
   has_many :cars
 
-  module ClassMethods
+  module DynamicClassSingletonMethods
     def count
       find(:all).size
     end
   end
 
-  module InstanceMethods
+  module DynamicClassInstanceMethods
     def occupation
       return job if job
       'Unemployed' 
@@ -141,7 +143,7 @@ end
 
 Next a car class has to be initialized
 
-class Car < DynARBase (alias for DynamicActiveResource::Base)
+class Car < DynARBase (alias for DynamicActiveResource::Base, inbuilt in the gem)
 end
 
 set resource options only at the top level( Person in this case)
@@ -161,7 +163,7 @@ person = Person.find('asur').cars it will hit the url http://localhost:8080/peop
 You would notice that its getting the cars for the person with name 'asur'. It does so because
 in the Person class a method called resource_identifier has been defined which says that the id
 is actually name instead of the database id. If the id attribute in the xml is set appropriately
-(to name in this case) then you do not need to define the method.
+(to 'name' in this case) then you do not need to define the method.
 
 2) belongs_to
 -------------
@@ -171,13 +173,13 @@ Again, referring to the example above
 class Person < DynamicActiveResource::Base
   has_many :cars
 
-  module ClassMethods
+  module DynamicClassSingletonMethods
     def count
       find(:all).size
     end
   end
 
-  module InstanceMethods
+  module DynamicClassInstanceMethods
     def occupation
       return job if job
       'Unemployed' 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: arusarka-dynamic-active-resource
 version: !ruby/object:Gem::Version 
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors: 
 - asur