fun_with_patterns 0.0.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OWI2MTM0MDJiN2ExNWJlOTQwM2M2OTJiNzYyZGJhZDQ3YjdhMmMwYQ==
+  data.tar.gz: !binary |-
+    YjAwZDFhZDQ2NjEwODUzZTUxYWZiNmU3MDk2OWMyMDI1MmNhMjYzMw==
+SHA512:
+  metadata.gz: !binary |-
+    MmUxNDc0YjMwMThjMmMxOTA5ZjFmNjkyODM1MmQ4MTMyNzVhZWNkYjg4OTVk
+    ZmRlZWQ1NjJjNTIzODk2ZGQ2YjRjMjZiNDAwOTdlOGQ3NGM4NWUyYmY4OTcy
+    OWU2N2Q5M2IzNTAyNmZlZDg2YzYwOGRmMmM2NjAwNDA3NTA0MmM=
+  data.tar.gz: !binary |-
+    YzU1ODdlNDQ0MjJjY2I1M2Y0NDQ3OGUyYjNiMGU3ZDMwMGNiOTc3M2MwN2U5
+    NjU0OGEzYzNkNmMzYjliZTY4YjgyMjA5YWI2N2E1NmU1OTg1OTQ1MzA1YWYz
+    YzRjYjU0YmYwZjU2NWE2NWQ5MWFiNTA3MzViODU4YTQ1NTExNDg=

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/Gemfile

@@ -0,0 +1,17 @@
+source "http://rubygems.org"
+# Add dependencies required to use your gem here.
+# Example:
+#   gem "activesupport", ">= 2.3.5"
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", "~> 3.5"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.5"
+  gem "jeweler", "~> 2.0"
+  
+end         
+
+gem "fun_with_files", "~> 0"
+gem "fun_with_version_strings", "~> 0"

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Bryce Anderson
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,78 @@
+= fun_with_patterns
+
+A collection of patterns that I seem to keep re-implementing.  I'll be adding them here as I find time to revise and refactor.  Until then, the only one I've gotten around to is...
+
+
+== Loader Pattern
+
+The Loader pattern is a good way to customize/modularize part of your app's functionality.  
+
+It assumes that you have a directory or set of directories, which include a bunch of definitions of various 'thingies' in different files.  For each directory you request loaded, it will look for these 'thingies' and try to load each file.  You need only define a load_item() and an <optional> loader_pattern_register_item() method.  load_item() can simply call load( the_ruby_file.rb ).  If you don't define a load_item() method, it will assume the default case: there is ruby code in that thar file, and I'm gonna execute it.
+
+Say you have a bunch of tasks, scattered over three directories, written in a task-describing DSL, one task per file:
+
+    my_lib/builtin/tasks/mysql/backup.db.rb
+    my_lib/builtin/tasks/website/maintain.users.rb
+    ~/.config/mylib/tasks/email_wendy.rb
+    ~/.config/mylib/tasks/backup_pr0n.rb
+    ~/project/tasks/submit_invoice.rb
+    
+Inside each file would be some code describing the task:
+
+    Task.new( "backup:db" ) do |t|
+        t.run_schedule :daily
+        t.action "mysqldump -u{{user}} -h{{host}} {{db}}"
+        t.user "dbuser"
+        t.host "mysql.hostapalooza.com"
+        ... you get the idea
+    end
+
+The tasks could number in the hundreds.  You want your Task class to have a way of loading them, registering them so you can find them, and so on, so you can run them.
+
+Task might look like this:
+
+    class Task
+      include FunWith::Patterns::Loader
+      
+      alias :loader_pattern_registry_key :name
+      
+      def initialize( name )
+        @name = name           # in the example, it was "backup:db"
+      end
+    end
+    
+To load your tasks, you'd run:
+
+    Task.loader_pattern_load_from_dir( "mylib/builtin/tasks" )
+    Task.loader_pattern_load_from_dir( "~/.config/mylib/tasks" )
+    Task.loader_pattern_load_from_dir( "~/project/tasks" )
+    
+And to snag the backup.db task, you'd just say:
+
+    task = Task.loader_pattern_registry_lookup( "backup:db" )
+    task.run
+
+For each directory you give it, it will:
+
+1. load all the .rb files in the directory/subdirectories
+2. register them into the registry.
+
+You can get some interesting behavior by overwriting individual methods.  For example, loading individual configurations from YAML or JSON or XML.  There's an example in the test/ folder.
+
+
+
+== Contributing to fun_with_patterns
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2013 Bryce Anderson. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,46 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "fun_with_patterns"
+  gem.homepage = "http://github.com/darthschmoo/fun_with_patterns"
+  gem.license = "MIT"
+  gem.summary = "A collection of useful patterns"
+  gem.description = "A collection of useful patterns"
+  gem.email = "keeputahweird@gmail.com"
+  gem.authors = ["Bryce Anderson"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "fun_with_patterns #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/lib/fun_with/patterns/loader.rb

@@ -0,0 +1,92 @@
+module FunWith
+  module Patterns
+    module Loader
+      def self.included( base )
+        base.extend( ClassMethods )
+        base.loader_pattern_extension("rb") if base.loader_pattern_extension.nil?
+      end
+    
+      module ClassMethods
+        # By default, looks for .rb files to evaluate
+        # ext => :all  (or "*") to load every file from directory.
+        # ext => :rb (or "rb") to load all .rb files (this is default)
+        # call without arguments to inquire about current extension.
+        def loader_pattern_extension( ext = nil )
+          case ext
+          when nil
+            # do nothing
+          when "*", :all
+            @loader_pattern_extension = "*"
+          else
+            @loader_pattern_extension = "*.#{ext}"
+          end
+          
+          @loader_pattern_extension
+        end
+        
+        def loader_pattern_verbose( verbosity = nil )
+          @loader_pattern_verbose = verbosity unless verbosity.nil?
+          @loader_pattern_verbose
+        end
+    
+        # 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 )
+          file = file.fwf_filepath
+          if file.file?
+            obj = eval( file.read )
+            
+            STDOUT.puts( "Loaded file #{file}" ) if self.loader_pattern_verbose
+            return obj
+          else
+            STDERR.puts( "(#{self.class}) Load failed, no such file: #{file}" )
+            return nil
+          end
+        rescue Exception => e
+          STDERR.puts( "Could not load file #{file}.  Reason: #{e.class.name} #{e.message}" )
+          
+          if self.loader_pattern_verbose
+            STDERR.puts( puts e.backtrace.map{|line| "\t\t#{line}"}.join("\n") )
+            STDERR.puts( "" )
+          end
+          
+          nil
+        end
+        
+        # Default, may want to override how the registry behaves.
+        def loader_pattern_register_item( obj )
+          return nil if obj.nil?
+          return (@loader_pattern_registry ||= {})[ obj.loader_pattern_registry_key ] = obj
+        end
+        
+        def loader_pattern_registry_lookup( key )
+          @loader_pattern_registry[key]
+        end
+        
+    
+        # Assumes that every file in the directory and subdirectories contain ruby code that
+        # will yield an object that the loader is looking for.  It also automatically
+        # adds the resulting object to a registry.
+        # You may want to override this if you're looking for different behavior.
+        def loader_pattern_load_from_dir( dir )
+          dir = dir.fwf_filepath
+          @loader_pattern_directories ||= []
+          @loader_pattern_directories << dir
+      
+          for file in dir.glob( "**", self.loader_pattern_extension )
+            obj = self.loader_pattern_load_item( file )
+            self.loader_pattern_register_item( obj )
+          end
+        end
+        
+        def loader_pattern_loaded_directories
+          @loader_pattern_directories ||= []
+        end
+      end
+    end
+  end
+end

data/lib/fun_with_patterns.rb

@@ -0,0 +1,12 @@
+require 'fun_with_files'
+require 'fun_with_version_strings'
+
+module FunWith
+  module Patterns
+  end
+end
+
+FunWith::Files::RootPath.rootify( FunWith::Patterns, __FILE__.fwf_filepath.dirname.up )
+FunWith::VersionStrings.version( FunWith::Patterns )
+
+FunWith::Patterns.root("lib", "fun_with").requir

data/test/helper.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'fun_with_patterns'
+
+require_relative 'user'
+require_relative 'yaml_obj'
+
+
+class Test::Unit::TestCase
+end
+
+class FunWith::Patterns::TestCase < Test::Unit::TestCase
+end

data/test/test_loader_pattern.rb

@@ -0,0 +1,47 @@
+require 'helper'
+
+class TestLoaderPattern < FunWith::Patterns::TestCase
+  context "testing basics" do
+    should "have all the pieces in place" do
+      assert defined?( FunWith::Patterns )
+      assert defined?( FunWith::Patterns::Loader )
+      assert defined?( FunWith::Patterns::Loader::ClassMethods )
+    end    
+  end
+  
+  context "testing User" do
+    setup do
+      User.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "users" ) )
+    end
+    
+    should "have all the right methods" do
+      for method in [ :loader_pattern_extension,
+                      :loader_pattern_verbose,
+                      :loader_pattern_load_item,
+                      :loader_pattern_register_item,
+                      :loader_pattern_load_from_dir ]
+        assert_respond_to( User, method )
+      end
+    end
+    
+    should "load users from test/users and test/users/more" do
+      assert User.loader_pattern_registry_lookup("Gary Milhouse")
+      assert_equal 54, User.loader_pattern_registry_lookup("Gary Milhouse").age
+    end
+  end
+  
+  context "testing YamlObj (non-standard loader)" do
+    setup do
+      YamlObj.loader_pattern_extension( "yaml" )
+      YamlObj.loader_pattern_load_from_dir( FunWith::Patterns.root( "test", "yamls" ) )
+    end
+    
+    should "look up items in registry" do
+      obj = YamlObj.loader_pattern_registry_lookup("Steve's Instagram Login")
+      assert_not_nil obj
+      assert_equal "password", obj.password
+    end
+  end
+end
+
+   

data/test/user.rb

@@ -0,0 +1,13 @@
+class User
+  include FunWith::Patterns::Loader
+
+  attr_accessor :name, :age
+  
+  def initialize( name, age )
+    @name = name
+    @age = age
+  end
+  
+  # For User, name will be used to look up the item in the registry.
+  alias :loader_pattern_registry_key :name
+end

data/test/users/mary.rb

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

data/test/users/more/gary.rb

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

data/test/users/steve.rb

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

data/test/users/wanda.rb

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

data/test/yaml_obj.rb

@@ -0,0 +1,49 @@
+require 'yaml'
+
+
+# Change the behavior by overriding
+class YamlObj
+  include FunWith::Patterns::Loader
+  
+  attr_accessor :label, :password, :host, :login
+  alias :loader_pattern_registry_key :label
+  
+  # The class initializes via yaml strings.
+  def self.loader_pattern_load_item( file )
+    obj = self.new( file.read )
+    self.loader_pattern_register_item( obj )
+  end
+  
+  def initialize( yaml )
+    yaml = Psych.load( yaml )
+    
+    @login    = yaml["login"]
+    @password = self.decrypt( yaml["password"] )
+    @host     = yaml["host"]
+    @label    = yaml["label"]
+  end
+  
+  # Warning: not production cryptography code.
+  def decrypt( str )
+    num = 13
+    
+    bytes = str.split("").map(&:bytes).map(&:first)
+    
+    lower_a = 'a'.bytes.first
+    upper_a = 'A'.bytes.first
+    is_lowercase = (lower_a .. (lower_a + 26))
+    is_uppercase = (upper_a .. (upper_a + 26))
+    rot_bytes = bytes.map{ |ch|
+      case ch
+      when is_lowercase
+        ((ch + num - lower_a) % 26 + lower_a)
+      when is_uppercase
+        ((ch + num - upper_a) % 26 + upper_a)
+      else
+        ch
+      end
+    }
+    
+    rot_bytes.map(&:chr).join("")
+  end
+end

data/test/yamls/mike/mike_amazon.yaml

@@ -0,0 +1,5 @@
+---
+host: login.amazon.com
+login: MikeIsNotSteve1964
+password: cnffjbeq
+label: Mike's Amazon Login

data/test/yamls/mike/mike_gmail.yaml

@@ -0,0 +1,5 @@
+---
+host: services.google.com
+login: MikeWillBuryYou
+password: cnffjbeq
+label: Mike's Google Login

data/test/yamls/steve/steve_instagram.yaml

@@ -0,0 +1,5 @@
+---
+host: signin.instagram.com
+login: StevePix1958
+password: cnffjbeq
+label: Steve's Instagram Login

metadata

@@ -0,0 +1,148 @@
+--- !ruby/object:Gem::Specification
+name: fun_with_patterns
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Bryce Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fun_with_files
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fun_with_version_strings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: A collection of useful patterns
+email: keeputahweird@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/fun_with/patterns/loader.rb
+- lib/fun_with_patterns.rb
+- test/helper.rb
+- test/test_loader_pattern.rb
+- test/user.rb
+- test/users/mary.rb
+- test/users/more/gary.rb
+- test/users/steve.rb
+- test/users/wanda.rb
+- test/yaml_obj.rb
+- test/yamls/mike/mike_amazon.yaml
+- test/yamls/mike/mike_gmail.yaml
+- test/yamls/steve/steve_instagram.yaml
+homepage: http://github.com/darthschmoo/fun_with_patterns
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: A collection of useful patterns
+test_files: []