interchangeable 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cda8cd912331c11bd0ae9b3d202e2a5f351c89a4
+  data.tar.gz: 92d11defc20ae888d9752fc2a0c9d6c84d5af735
+SHA512:
+  metadata.gz: 91252026af2d9053a4b3afedb6c059ed9e978f4e30787c2fcb7b826bdec6bbb88ca64152c7f2441b0c27da9adc8cec9c2e957b81ed6138a5ccc02c7b715882a5
+  data.tar.gz: 49bfa7e108b444af8b4849dbfa36b17ed7cff4f4b65df58a47482d245e3833cf9effdd43c81426e82625a9b2ee77f2d9c443b6a92b991a1fe7b8058079ed682c

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in interchangeable.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Darren Cauthon
+
+MIT License
+
+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/MIT-license.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Scott Bellware
+
+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.md

@@ -0,0 +1,41 @@
+# Interchangeable
+
+Create and maintain interchangeable components in Ruby. 
+
+## Usage
+
+```ruby
+class MyApi
+  def api_key
+    "abc"
+  end
+end
+```
+
+can become
+
+```ruby
+class MyApi
+  interchangeable_instance_method :api_key
+end
+```
+
+Elsewhere in your application, you can define the method like so:
+
+```ruby
+  Interchangeable.define MyApi, :api_key { 'anything' }
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'interchangeable'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install interchangeable

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/interchangeable.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'interchangeable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "interchangeable"
+  spec.version       = Interchangeable::VERSION
+  spec.authors       = ["Darren Cauthon"]
+  spec.email         = ["darren@cauthon.com"]
+  spec.summary       = %q{Create and describe interchangeable components.}
+  spec.description   = %q{Extract interchangeable components in your application. Identify them, describe them, and allow others to swap them out easily.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+end

data/lib/interchangeable/version.rb

@@ -0,0 +1,3 @@
+module Interchangeable
+  VERSION = "0.0.1"
+end

data/lib/interchangeable.rb

@@ -0,0 +1,27 @@
+require "interchangeable/version"
+
+class Class
+  def interchangeable_instance_method *args, &block
+    Interchangeable.entries << Struct.new(:method_name, :target, :level)
+                             .new(args[0], self, :instance)
+    Interchangeable.define(self, args[0], &block) if block
+  end
+end
+
+module Interchangeable
+
+  class << self
+
+    attr_accessor :entries
+    def entries
+      @settings ||= []
+    end
+
+    def define the_class, method_name, &block
+      the_class.instance_eval do
+        define_method method_name, &block
+      end
+    end
+  end
+
+end

data/spec/interchangeable_spec.rb

@@ -0,0 +1,125 @@
+require_relative 'minitest_spec'
+
+describe Interchangeable do
+
+  before do
+    Interchangeable.instance_eval { @settings = nil }
+  end
+
+  describe "defining an instance-level method on a class" do
+
+    [
+      ["Blah", "something"],
+      ["Yawn", "applesauce"],
+    ].map { |x| Struct.new(:class_name, :method_name).new(*x) }.each do |example|
+
+      describe "noting the method on a class" do
+
+        before do
+          eval("class #{example.class_name}
+                  interchangeable_instance_method :#{example.method_name}
+                end")
+        end
+
+        describe "entries" do
+
+          it "should create an entry" do
+            Interchangeable.entries.count.must_equal 1
+          end
+
+          it "should include the method name" do
+            Interchangeable.entries.first.method_name.must_equal example.method_name.to_sym
+          end
+
+          it "should return the target" do
+            Interchangeable.entries.first.target.must_equal eval(example.class_name)
+          end
+
+          it "should say that it's an instance method" do
+            Interchangeable.entries.first.level.must_equal :instance
+          end
+
+        end
+
+        describe "defining the method later" do
+
+          let(:the_return_value) { Object.new }
+
+          before do
+            object = the_return_value
+            Interchangeable.define(eval(example.class_name), eval(":#{example.method_name}")) { object }
+          end
+
+          it "should stamp the method on the object" do
+            instance = eval(example.class_name).new
+            instance.send(example.method_name.to_sym).must_be_same_as the_return_value
+          end
+
+        end
+
+        describe "accessing private members of the class" do
+
+          before { Interchangeable.define(eval(example.class_name), eval(":#{example.method_name}")) { @something } }
+
+          it "should be able to access the private member" do
+            object = Object.new
+
+            instance = eval(example.class_name).new
+            instance.instance_eval { @something = object }
+            instance.send(example.method_name.to_sym).must_be_same_as object
+          end
+
+        end
+
+        describe "defining the client-specific method, but with arguments" do
+
+          let(:apple)  { Object.new }
+          let(:orange) { Object.new }
+
+          before do
+            Interchangeable.define(eval(example.class_name), eval(":#{example.method_name}")) do |a, b|
+              [a, b]
+            end
+          end
+
+          it "should allow me to call the method with arguments" do
+            instance = eval(example.class_name).new
+
+            result = instance.send(example.method_name.to_sym, apple, orange)
+            result.must_equal [apple, orange]
+          end
+
+        end
+
+      end
+
+      describe "noting the method on a class with a default implementation" do
+
+        ['potato', 'tomato'].each do |default_value|
+
+          describe "multiple examples" do
+
+            before do
+              eval("class #{example.class_name}
+                      interchangeable_instance_method(:#{example.method_name}) { \"#{default_value}\" }
+                    end")
+            end
+
+            it "should return the default value if called" do
+              instance = eval(example.class_name).new
+
+              result = instance.send(example.method_name.to_sym)
+              result.must_equal default_value
+            end
+
+          end
+
+        end
+
+      end
+
+    end
+
+  end
+
+end

data/spec/minitest_spec.rb

@@ -0,0 +1,3 @@
+require 'minitest/autorun'
+require 'minitest/spec'
+require_relative '../lib/interchangeable'

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: interchangeable
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Darren Cauthon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Extract interchangeable components in your application. Identify them,
+  describe them, and allow others to swap them out easily.
+email:
+- darren@cauthon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- MIT-license.txt
+- README.md
+- Rakefile
+- interchangeable.gemspec
+- lib/interchangeable.rb
+- lib/interchangeable/version.rb
+- spec/interchangeable_spec.rb
+- spec/minitest_spec.rb
+homepage: ''
+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: Create and describe interchangeable components.
+test_files:
+- spec/interchangeable_spec.rb
+- spec/minitest_spec.rb