fun_with_patterns 0.0.5 → 0.0.6

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTQwYjliNzVlNWFkNmYxMjkxZTU4NTY1NmZjZDEwMmNmMTE5NDU0MQ==
+    NDYzOWM3MmIyOTRmMWRiZTYxNWExNjc0MGJkNDE2MzcyOTIwYzQ3Zg==
   data.tar.gz: !binary |-
-    NDAyMWQ1ZTU4M2JiYjdjODkwMGIwM2IwMjM0YjZlMDYxZGY2M2M5Ng==
+    MDBhZTdlYTNkMTAwY2MwMDE0ZGQ0MDljYjlkNjdlMTE1MGE2Njk2Yg==
 SHA512:
   metadata.gz: !binary |-
-    YmFkOTUzMWQ2MTViZDEzZjZjYTY2NzBmZDU5OTE2NjQ0NzgxODQ1ZGRjYjYx
-    MWFhMTgxOGMyMWE0MjVkYWRiNDcxOGYxODg4Y2VmMDQ2Y2JiYWY4MGQ1Mjc2
-    MDQxMzBiMTg4OGQ4YzM1YmJjZDcxM2MxYWY5OTZlNTdkYjg1ZWI=
+    NzAyN2ZkNDVkMzBhMTc1NjkzZWE2ZDc2NTczMzAwN2JiMzcwOWZkMzQ0NDY0
+    OTM4ZWVjODc4MzE4OGI5MjNjMzRmMWI4M2IwYzcyN2JiYjY4ZTJkYzQ3Mjg1
+    ZWQxN2MwM2Y5Mjk0OGFkNzZlYjU0YTY5YmEyMmVjYjIxZGM1YTM=
   data.tar.gz: !binary |-
-    N2EzZjE5OTNlN2YzZmNjMTAwNDE2YTU5NGYxMjFlN2JkMDE1OTJkMjVjNjBl
-    ODQ4YjY0MzI5YWFjYjgxYzg4ZDQ4ZTQ1YWM3OTljY2FlMzllYWZjZTk3ZTZi
-    N2RiNDBlN2EyMjY4ODM0YjU0ZDgxZThjMzM3MTk4MzdhM2VjMmY=
+    NzFiZjIzMzVmMzAxNmZiZGU1Mzk2NTEyMmEwMjEyMDc1MzZlZWYwYjA2YTBi
+    OWRkN2NhMzRkZDgyMDcxZDg1YjVhMTc0Mjk4ZWFiNWE0ODMzNWVkYzFlZjBi
+    MjYyNDg1NTcyOWI0YjVhM2UwYzE0NzUwNDViYzBiNTY4MzRkMTk=

data/CHANGELOG.markdown

@@ -1,6 +1,15 @@
 Changelog
 =========
 
+0.0.6
+-----
+
+Improved Loader.
+
+* Default behavior infers the lookup key from the filename that the configuration was loaded into.
+* No longer have to explicitly include FunWith::Patterns::Loader in the class/module.
+
+
 0.0.5
 -----
 

data/README.rdoc

@@ -79,7 +79,7 @@ More example code!
       include FunWith::Patterns::Loader
       loader_pattern_configure( :bracketwise_lookup, 
                                 :warn_on_key_change, 
-                                { :verbose => true, :load } )
+                                { :verbose => true, :load_style =>  } )
     end
 
 loader_pattern_configure is a quickie method for setting up a variety of behaviors.  Options so far:  
@@ -87,7 +87,8 @@ loader_pattern_configure is a quickie method for setting up a variety of behavio
     :bracketwise_lookup  : instead of calling Klass.loader_pattern_registry_lookup( "string" )
                            you can just call Klass["string"]
                             
-    {:key => :<sym>}     : loader determines registry key by calling this method
+    {:key => :<sym>}     : loader determines registry key by calling this method.  If no key is provided, then
+                           it infers a key by using "directory:subdirectory:filename_without_extension"
       
     :warn_on_key_changes : If a newly loaded item has an existing registry key, it prints a warning as it overwrites
       
@@ -117,27 +118,25 @@ The styles need some explanation:
                        - name: Boris
                        
                        would end up calling klass_object.name=( "Boris" )
+					   
+	<A MODULE>       : Extends the target with the provided module.  For example,
+	
+	                   module RandomLoaderStyle
+        					     def loader_pattern_load_item( file )
+    				             self.loader_pattern_rescue_failing_item_load( file ) do
+    				               obj = WeirdObject.factory( :random_seed => file.read )
+      
+    				               return obj
+                         end
+				               end
+                     end
+                     
+                     class RandomObjects
                        
+                     end
 
-TODO: I feel like a default label should maybe come out of the filename (zero-config and all that), but haven't built it.
-
-== Reloadable ==
-
-You're in the command line, developing a new class, and you find yourself forever restarting the whole project to affect changes, or constantly copy-pasting the class into the command line.  Tired?  Frustrated?  Let .reloadable! help!  Just put the method inside your class / module definition, and call Klass.reload! whenever you like.
 
-    require 'fun_with_patterns'
 
-    module SausageFest
-      class BratwurstCounter
-        reloadable!
-      
-        def initialize( initial_brat_count )
-          ... and so on
-          
-          
-    (irb) >>  SausageFest::BratwurstCounter.reload! 
-      
-Easy as peasy.  Note, it may be buggy if the file only contains part of the definition, defines other classes as well, or performs other actions.  Use at your own risk, and at great peril to your coworkers.
 
 
 

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/fun_with/patterns/loader/class_methods.rb

@@ -45,7 +45,7 @@ module FunWith
           nil
         end
         
-        # Default, may want to override how the registry behaves.
+        # Default method, user of the class may want to override how the registry behaves.
         # If you don't provide a key argument, then the object needs to 
         # respond to .loader_pattern_registry_key()
         def loader_pattern_register_item( obj, key = nil )
@@ -56,6 +56,7 @@ module FunWith
             if obj.respond_to?( :loader_pattern_registry_key )
               key = obj.loader_pattern_registry_key
             else
+              # inferring a default key from the filepath is handled by the load_from_dir() method
               raise "#{self.class} not registered.  No registry key given, and object does not respond to .loader_pattern_registry_key()."
             end
           end
@@ -112,7 +113,18 @@ module FunWith
             
             for file in dir.glob( :ext => self.loader_pattern_extension, :recurse => true )
               obj = self.loader_pattern_load_item( file )
-              self.loader_pattern_register_item( obj ) if self.loader_pattern_is_item_registerable?( obj )
+              
+              # checks to see if you're only allowed to register objects of certain types
+              if self.loader_pattern_is_item_registerable?( obj )
+                if obj.respond_to?( :loader_pattern_registry_key )
+                  self.loader_pattern_register_item( obj )
+                else
+                  # Generate a default key from the filename
+                  chunks = (file.relative_path_from( dir ).dirname.split << file.basename_no_ext).map(&:to_s).reject{|s| s == "." }
+                  key = chunks.join(":")
+                  self.loader_pattern_register_item( obj, key )
+                end
+              end
             end
           end
         end
@@ -168,6 +180,8 @@ module FunWith
                   when :yaml
                     self.extend( LoadingStyles::YAML )
                     self.loader_pattern_extension( [:yml, :yaml] )
+                  when Module
+                    self.extend( val )
                   else
                     raise "Unknown Loader loading style: #{val.inspect}"
                   end

data/lib/fun_with/patterns/loader/object_api.rb

@@ -0,0 +1,17 @@
+module FunWith
+  module Patterns
+    module Loader
+      
+      # To simplify installing the loader pattern, loader_pattern_configure() is now going to be
+      # callable on all objects by default, and will include FunWith::Patterns::Loader
+      module ObjectAPI
+        def loader_pattern_configure( *args )
+          include FunWith::Patterns::Loader
+          
+          # hoping (vainly) that when the include finishes, loader_pattern_configure() is now a different method
+          loader_pattern_configure( *args )
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/patterns/loader.rb

@@ -3,6 +3,8 @@ module FunWith
     module Loader
       def self.included( base )
         base.extend( ClassMethods )
+        
+        # set a few defaults
         base.extend( LoadingStyles::Eval ) # provides a default load_item method
         base.loader_pattern_extension( :rb ) if base.loader_pattern_extension.nil?
       end

data/lib/fun_with_patterns.rb

@@ -5,4 +5,5 @@ FunWith::Gems.make_gem_fun( "FunWith::Patterns" )
 
 # Activate Object#get_and_set / Module#get_and_set by calling GetAndSet.activate
 FunWith::Patterns::GetAndSet.extend( FunWith::Patterns::GetAndSetAPI )
+Object.send( :include, FunWith::Patterns::Loader::ObjectAPI )
 

data/test/test_loader_pattern.rb

@@ -11,12 +11,13 @@ class TestLoaderPattern < FunWith::Patterns::TestCase
   
   context "testing User" do
     setup do
-      User.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "eval" ) )
+      User1.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "eval" ) )
       User2.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "eval" ) )
       User3.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "instance_exec" ) )
       User4.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "yaml" ) )
+      User5.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users", "yaml" ) )
       
-      @user_classes = [User, User2, User3, User4]
+      @user_classes = [User1, User2, User3, User4, User5]
     end
     
     should "have all the right methods" do
@@ -33,19 +34,23 @@ class TestLoaderPattern < FunWith::Patterns::TestCase
     end
     
     should "load users from test/users into various classes" do
-      for klass in @user_classes
+      for klass in @user_classes[0..3]
         assert klass.loader_pattern_registry_lookup("Gary Milhouse"), "#{klass} did not load Gary.  Poor Gary."
         assert_equal 54, klass.loader_pattern_registry_lookup("Gary Milhouse").age, "#{klass} did not load Gary with proper age data."
       end
+        
+      # User5 uses different keys, so handling separately
+      assert_equal 53, User5["wanda"].age
+      assert_equal "Wanda Wimbledon", User5["wanda"].name
     end
     
     should "lookup via brackets" do
-      User.loader_pattern_configure( :bracketwise_lookup )
-      assert_equal 54, User["Gary Milhouse"].age
+      User1.loader_pattern_configure( :bracketwise_lookup )
+      assert_equal 54, User1["Gary Milhouse"].age
       
       # User2 class is already configured for bracketwise lookup
       m = User2["Gary Milhouse"]
-      assert_kind_of( User, m )
+      assert_kind_of( User1, m )
       assert_equal 54, m.age
     end
   end

data/test/user.rb

@@ -1,6 +1,5 @@
-class User
-  include FunWith::Patterns::Loader
-
+class User1
+  loader_pattern_configure()   
   attr_accessor :name, :age
   
   def initialize( name, age )
@@ -15,7 +14,6 @@ end
 class User2
   attr_accessor :name, :age
 
-  include FunWith::Patterns::Loader
   loader_pattern_configure( :bracketwise_lookup, {:key => :name} )
   
   def initialize( name, age )
@@ -29,7 +27,6 @@ class User3
   
   get_and_set :name, :age
   
-  include FunWith::Patterns::Loader
   loader_pattern_configure( :bracketwise_lookup, 
                             { :key => :name },
                             { :style => :instance_exec }   # Create object, run code in configuration file inside the object's context.
@@ -40,10 +37,15 @@ end
 class User4
   attr_accessor :name, :age
   
-  include FunWith::Patterns::Loader
   loader_pattern_configure( :bracketwise_lookup, 
                             { :key => :name }, 
                             { :style => :yaml }
                           )
 end
+
+class User5
+  attr_accessor :name, :age
+  
+  loader_pattern_configure( :bracketwise_lookup, :style => :yaml ) 
+end
   

data/test/users/eval/mary.rb

@@ -1 +1 @@
-User.new( "Mary Masterson", 27 )
+User1.new( "Mary Masterson", 27 )

data/test/users/eval/more/gary.rb

@@ -1 +1 @@
-User.new( "Gary Milhouse", 54 )
+User1.new( "Gary Milhouse", 54 )

data/test/users/eval/steve.rb

@@ -1 +1 @@
-User.new( "Steve Sturmond", 72 )
+User1.new( "Steve Sturmond", 72 )

data/test/users/eval/wanda.rb

@@ -1 +1 @@
-User.new( "Wanda Wimbledon", 53 )
+User1.new( "Wanda Wimbledon", 53 )

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_patterns
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
 platform: ruby
 authors:
 - Bryce Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-04 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fun_with_gems
@@ -60,6 +60,7 @@ files:
 - ./lib/fun_with/patterns/loader/loading_styles/eval.rb
 - ./lib/fun_with/patterns/loader/loading_styles/instance_exec.rb
 - ./lib/fun_with/patterns/loader/loading_styles/yaml.rb
+- ./lib/fun_with/patterns/loader/object_api.rb
 - ./lib/fun_with_patterns.rb
 - ./test/helper.rb
 - ./test/test_get_and_set.rb