fun_with_configurations 0.0.6 → 0.0.7

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZDQ0ZTVhMmQwOTQ1ZmQ2NWZkMTM2ZWYwMzRkNjdiZTAxNDRjOGI0ZQ==
+    NGQ3MzlhYzM1NWY2MDBlZTEyMzE5YTIyNDBlNzkzNDM4YmFlN2FmOQ==
   data.tar.gz: !binary |-
-    MWRkNmYxNTNmNDRjMTJiMzhlYTE2ZDBhYTY2NDFhZGI4ODE4OTc4NQ==
+    NDYwNWJhNmU0MDRiMjg5NDg0MzcwMDNlMWZhYzhjM2QwM2ZhZWIwYw==
 SHA512:
   metadata.gz: !binary |-
-    MWI0YWQ0MzNjZTFjMzg4ZGQxODg2N2NlN2JkMzRmY2E1ZDcwODgyMmI0ZjNl
-    MjNiNjE3Nzk5N2E1MWU5M2YzOTdkZDQ0ZTU5ZWQwYjA2ZGM3OGMwMzZmOWQy
-    ZmIzOWI4OThkN2JjZDVjMDcyODE2ZDc4ZDIxMDM3OGFiN2IzOWE=
+    MTMzOTc4ODA1MmMxMmFiZDY5ZTU3OWI5MjEzZjQyODdjNDNiNDA3MWYyM2Nl
+    NjJjMzIzMzY5N2QzOWU1ZGM1MzUwOGI3M2U2MDVkNDI5MjExMWY4OTBkZWUz
+    MmE2NmE4YTcyOTM4MDZjODZiNmFhOGU0MmQ1YzVjZjJlNWQ1MDE=
   data.tar.gz: !binary |-
-    OGExZjIwOWUzNjE5OWQ5N2VhNTc2ODQ5NWY4ZGE1ZGE2MWFkNjI1ZmVhMWQ3
-    OGFmZTFiYzlmNTNhNTQ3MGM2NGI1NDMyOTNiYTkyNzk3NjM2NzU5ZTkxOTNm
-    Yjk2Mjk0ODc2NDE1Y2Q2NDZmOGIzYjIwNTYwYzg1MjdmNjdiZmQ=
+    OGZjMTc4ZTI5NTU1NDU5YzQyNjA4Yzg4MjIyODFjYjg5NTFjMTY0YTgxZTU4
+    YzdkNjZmMjA2MjY1ZWVhYjZlMmJlYzIwOWZmNDg0M2JiNmU5ODYwNzExOTIz
+    M2M1NmMyOTA3YTk0M2MwY2YxYWI4OTM4Mzc2MzQ2MjJiMTIwMTg=

data/Gemfile

@@ -14,4 +14,4 @@ group :development do
   gem "fun_with_testing", "~> 0.0"
 end
 
-gem "fun_with_gems", "~> 0.0"
+gem "fun_with_gems", "~> 0.0", ">= 0.0.2"

data/README.rdoc

@@ -162,6 +162,34 @@ Basically, this is meant to spare you from typing the longhand form:
 
 
 
+
+
+== FunWith::Patterns::Loader integration
+
+To use configurations with the Loader pattern:
+
+    require 'fun_with_configurations'
+    require 'fun_with_patterns'
+
+    class Computer
+      attr_accessor :label
+      
+      # Look up individual configurations via Computer[:bob_system]
+      loader_pattern_configure( :bracketwise_lookup,
+                                :warn_on_key_change,  # Warn if an existing lookup key is overwritten
+                                { :key   => :label,     # Key is found by calling method label()
+                                  :style => FunWith::Configurations::LoadingStyle } ) # Interprets the file as a FWC::Config
+    end
+
+    Computer.loader_pattern_load_from_dir( "~/.config/computers" )  # loads all the configurations in the directory
+    puts Computer[:bob_system].memory  # ==> "4GB"
+
+Internally, the LoadingStyle simply offloads the loading work to Config.from_file(), so any valid configuration format will do (.rb, .yaml).
+
+
+    
+
+
 == Contributing to fun_with_configurations
 
 [Boilerplate from Jeweler.  Seems reasonable.]

data/VERSION

@@ -1 +1 @@
-0.0.6
+0.0.7

data/lib/fun_with/configurations/config.rb

@@ -60,13 +60,6 @@ module FunWith
         end
       end
       
-      def self.key_check( sym )
-        @reserved_symbols ||= Config.instance_methods - self.fwc_overridden_methods
-        
-        raise KeyError.new("#{sym} is not a symbol") unless sym.is_a?(Symbol)
-        raise KeyError.new("#{sym} is reserved for use by Hash") if @reserved_symbols.include?( sym )
-      end
-      
       def try( *keys )
         (t = TryObject.new( self )).tap do
           for key in keys
@@ -120,19 +113,6 @@ module FunWith
         end
       end
       
-      def self.from_hash( hash )
-        (config = self.new).tap do
-          for k, v in hash
-            config.send( k, v.is_a?( Hash ) ? self.from_hash( v ) : v )
-          end
-        end
-        config
-      end
-      
-      def self.fwc_overridden_methods
-        ConfigOverriddenMethods.instance_methods.grep( /[^=]$/ )
-      end
-      
       def fwc_overridden_methods
         self.class.fwc_overridden_methods
       end

data/lib/fun_with/configurations/config_api.rb

@@ -0,0 +1,47 @@
+module FunWith
+  module Configurations
+    # methods on the FunWith::Configurations::Config class itself.
+    module ConfigAPI
+      def key_check( sym )
+        @reserved_symbols ||= Config.instance_methods - self.fwc_overridden_methods
+        
+        raise KeyError.new("#{sym} is not a symbol") unless sym.is_a?(Symbol)
+        raise KeyError.new("#{sym} is reserved for use by Hash") if @reserved_symbols.include?( sym )
+      end
+      
+      
+      def from_file( file )
+        file = file.fwf_filepath
+
+        case file.ext
+        when "rb"
+          self.new do
+            eval( file.read )
+          end
+        when "yml", "yaml"
+          self.from_yaml( file.read )
+        else
+          warn( "Unknown filetype: #{file.ext} (file:#{file}}). Returning empty config." )
+          self.new
+        end
+      end
+      
+      def from_hash( hash )
+        (config = self.new).tap do
+          for k, v in hash
+            config.send( k, v.is_a?( Hash ) ? self.from_hash( v ) : v )
+          end
+        end
+        config
+      end
+      
+      def from_yaml( yaml_string )
+        self.from_hash( Psych.load( yaml_string ) )
+      end
+      
+      def fwc_overridden_methods
+        ConfigOverriddenMethods.instance_methods.grep( /[^=]$/ )
+      end
+    end
+  end
+end

data/lib/fun_with/configurations/{module_includes.rb → gem_api.rb}

@@ -1,6 +1,6 @@
 module FunWith
   module Configurations
-    module ModuleIncludes
+    module GemAPI
       def configure( object, config = nil, &block )
         if block_given?
           object.install_fwc_config( config, &block )          
@@ -20,6 +20,7 @@ module FunWith
         end
       end
       
+      # 
       protected
       def configuration_argument_type?( arg )
         case arg

data/lib/fun_with/configurations/loader_style.rb

@@ -0,0 +1,21 @@
+# For integrating with FunWith::Patterns::LoaderPattern
+# See README for example usage
+module FunWith
+  module Configurations
+    module LoadingStyle
+      # Default behavior: read the file, evaluate it, expect a ruby object
+      # of the class that the loader pattern is installed on.  If anything goes
+      # wrong (file no exist, syntax error), returns a nil.
+      #
+      # Override in your class if you need your files translated
+      # into objects differently.
+      def loader_pattern_load_item( file )
+        self.loader_pattern_rescue_failing_item_load( file ) do
+          obj = Config.from_file( file )
+      
+          return obj
+        end
+      end
+    end
+  end
+end

data/lib/fun_with/configurations/object_methods.rb

@@ -0,0 +1,32 @@
+module FunWith
+  module Configurations
+    module ObjectMethods
+      def install_fwc_config( config = nil, &block )
+        extend FunWith::Configurations::Configurable
+        self.config = config || FunWith::Configurations::Config.new( &block )
+        self.config.fwc_configured_object = self
+        self.config
+      end
+  
+      def install_fwc_config_from_file( file )
+        config = FunWith::Configurations::Config.from_file( file )
+        self.install_fwc_config( config )
+        self.fwc_configuration_file = file
+        self.config
+      end
+  
+      def install_fwc_config_from_hash( hash )
+        config = FunWith::Configurations::Config.from_hash( hash )
+        self.install_fwc_config( config )
+        self.config
+      end
+
+      def install_fwc_config_from_yaml( yaml_string )
+        config = Config.from_yaml( yaml_string )
+        self.install_fwc_config( config )
+        self.config
+      end
+    end
+  end
+end
+

data/lib/fun_with_configurations.rb

@@ -1,10 +1,5 @@
-require 'fun_with_files'
+require 'fun_with_gems'
 
-module FunWith
-  module Configurations
-  end
-end
-
-FunWith::Files::RootPath.rootify( FunWith::Configurations, __FILE__.fwf_filepath.dirname.up )
-FunWith::Configurations.root( "lib", "fun_with", "configurations" ).requir
-FunWith::Configurations.extend( FunWith::Configurations::ModuleIncludes )
+FunWith::Gems.make_gem_fun( "FunWith::Configurations" )
+FunWith::Configurations::Config.extend( FunWith::Configurations::ConfigAPI )
+Object.send(:include, FunWith::Configurations::ObjectMethods)

data/test/test_loading_from_file.rb

@@ -1,10 +1,6 @@
 require 'helper'
 
-module FunWith
-  module Configurations
-    class ServerManager
-    end
-  end
+class FunWith::Configurations::ServerManager
 end
 
 class TestLoadingFromFile < FunWith::Configurations::TestCase

data/test/test_setup_basics.rb

@@ -2,9 +2,10 @@ require 'helper'
 
 class TestSetupBasics < FunWith::Configurations::TestCase
   context "testing basics" do
-    context "FunWith::Configurations module"
-    should "respond to :configure" do
-      assert FunWith::Configurations.respond_to?(:configure)
+    context "FunWith::Configurations module" do
+      should "respond to :configure" do
+        assert FunWith::Configurations.respond_to?(:configure)
+      end
     end
   end
 end

metadata

@@ -1,19 +1,22 @@
 --- !ruby/object:Gem::Specification
 name: fun_with_configurations
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Bryce Anderson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-31 00:00:00.000000000 Z
+date: 2015-02-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fun_with_gems
   requirement: !ruby/object:Gem::Requirement
     requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
@@ -21,6 +24,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.0.2
     - - ~>
       - !ruby/object:Gem::Version
         version: '0.0'
@@ -49,11 +55,13 @@ extra_rdoc_files:
 files:
 - ./lib/fun_with/configurations/chain_error.rb
 - ./lib/fun_with/configurations/config.rb
+- ./lib/fun_with/configurations/config_api.rb
 - ./lib/fun_with/configurations/config_overridden_methods.rb
 - ./lib/fun_with/configurations/configurable.rb
+- ./lib/fun_with/configurations/gem_api.rb
 - ./lib/fun_with/configurations/key_error.rb
-- ./lib/fun_with/configurations/module_includes.rb
-- ./lib/fun_with/configurations/object.rb
+- ./lib/fun_with/configurations/loader_style.rb
+- ./lib/fun_with/configurations/object_methods.rb
 - ./lib/fun_with/configurations/try_object.rb
 - ./lib/fun_with/configurations/try_result.rb
 - ./lib/fun_with_configurations.rb

data/lib/fun_with/configurations/object.rb

@@ -1,35 +0,0 @@
-class Object
-  def install_fwc_config( config = nil, &block )
-    extend FunWith::Configurations::Configurable
-    self.config = config || FunWith::Configurations::Config.new( nil, &block )
-    self.config.fwc_configured_object = self
-    self.config
-  end
-  
-  def install_fwc_config_from_file( file )
-    file = file.fwf_filepath
-    
-    case file.ext
-    when "rb"
-      self.install_fwc_config do
-        eval( file.read )
-      end
-    when "yml", "yaml"
-      self.install_fwc_config_from_yaml( file.read )
-    end
-    
-    self.fwc_configuration_file = file
-    self.config
-  end
-  
-  def install_fwc_config_from_hash( hash )
-    self.install_fwc_config( FunWith::Configurations::Config.from_hash( hash ) )
-    self.config
-  end
-
-  def install_fwc_config_from_yaml( yaml_string )
-    self.install_fwc_config_from_hash( Psych.load( yaml_string ) )
-    self.config
-  end
-end
-