windcharger 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c46f7711e884e9414c36dbae526dd1ce280797fa
+  data.tar.gz: 850d9751a2023317625aad78a5dcdb1444e931e6
+SHA512:
+  metadata.gz: 5a8cc81462b30354c72ff7e5fb3bc3e9e07a60296dfa18400a9949450f929f2865877ccbb0c12dedebb30d4f97a4aabeba284a09f2b6a417429e408e2159b689
+  data.tar.gz: e9ba620552c61fa1fd61f603434f6ed81896145b8eeaf6a28a1ccc5e745df52a90f8f21e1d66d1fe0c73375c17b831dd6e27bd23f9093a5cec84ce538a2a3ece

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 J. Andrew Marshall <http://johnandrewmarshall.com>
+
+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/README.md

@@ -0,0 +1,73 @@
+# Windcharger
+
+[![Build Status](https://secure.travis-ci.org/amarshall/windcharger.png?branch=master)](https://travis-ci.org/amarshall/windcharger)
+[![Code Climate rating](https://codeclimate.com/github/amarshall/windcharger.png)](https://codeclimate.com/github/amarshall/windcharger)
+[![Gem Version](https://badge.fury.io/rb/windcharger.png)](https://rubygems.org/gems/windcharger)
+
+![Windcharger mascot. He carries powerful magnets in his arms that he can use to manipulate large objects.](https://i.imgur.com/lApzHFP.jpg "He carries powerful magnets in his arms that he can use to manipulate large objects.")
+
+Windcharger is a small library to easily make objects that transform input via many methods.
+
+## Installation
+
+Install as usual: `gem install windcharger` or add `gem 'windcharger'` to your Gemfile.
+
+## Usage
+
+Declare methods as attributes by extending `Windcharger::Attributes` and preceding methods with `attribute`:
+
+```ruby
+class MyTransformer
+  extend Windcharger::Attributes
+
+  attribute
+  def foo; end
+
+  attribute
+  def bar; end
+
+  def not_an_attribute; end
+end
+
+MyTransformer.attributes  #=> [:foo, :bar]
+```
+
+This isn’t very useful on its own, so include `Windcharger::HashTransformer` to get the `transform` method:
+
+```ruby
+class MyTransformer
+  extend Windcharger::Attributes
+  include Windcharger::HashTransformer
+
+  attribute
+  def foo
+    :the_foo
+  end
+
+  attribute
+  def bar
+    :walked_into_a_bar
+  end
+
+  def not_an_attribute
+    42
+  end
+end
+
+my_transformer = MyTransformer.new
+my_transformer.transform #=> { :foo => :the_foo, :bar => :walked_into_a_bar }
+```
+
+Add an `initialize` that takes some input and then transform it to each attribute in their respective methods and you have a nice transformer object.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## Credits & License
+
+Copyright © 2013 J. Andrew Marshall. License is available in the LICENSE file.

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Run specs'
+RSpec::Core::RakeTask.new do |t|
+  t.ruby_opts = '-w'
+end
+
+task :default => :spec

data/lib/windcharger.rb

@@ -0,0 +1,5 @@
+require 'windcharger/version'
+
+module Windcharger
+  # Your code goes here...
+end

data/lib/windcharger/attributes.rb

@@ -0,0 +1,19 @@
+module Windcharger
+  module Attributes
+    def attributes
+      @__attributes || []
+    end
+
+    private
+
+    def attribute
+      @__windcharger_next_is_attribute = true
+    end
+
+    def method_added name
+      return unless @__windcharger_next_is_attribute
+      (@__attributes ||= []) << name
+      @__windcharger_next_is_attribute = false
+    end
+  end
+end

data/lib/windcharger/hash_transformer.rb

@@ -0,0 +1,10 @@
+module Windcharger
+  module HashTransformer
+    def transform
+      self.class.attributes.each_with_object({}) do |attribute, hash|
+        hash[attribute] = send attribute
+      end
+    end
+    alias_method :to_h, :transform
+  end
+end

data/lib/windcharger/version.rb

@@ -0,0 +1,3 @@
+module Windcharger
+  VERSION = '0.1.0'
+end

data/spec/spec_helper.rb

@@ -0,0 +1,9 @@
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/windcharger/attributes_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+require 'windcharger/attributes'
+
+describe Windcharger::Attributes do
+  it "attributes is an empty array by default" do
+    transformer_class = Class.new { extend Windcharger::Attributes }
+    expect(transformer_class.attributes).to eq []
+  end
+
+  it "attribute is private" do
+    transformer_class = Class.new { extend Windcharger::Attributes }
+    expect { transformer_class.attribute }.to raise_error NoMethodError, /private/
+  end
+
+  it "does not add a method not preceded by a call to attribute to the list of attributes" do
+    transformer_class = Class.new do
+      extend Windcharger::Attributes
+
+      def foo; end
+    end
+    expect(transformer_class.attributes).to eq []
+  end
+
+  it "adds a method preceded by a call to attribute to the list of attributes" do
+    transformer_class = Class.new do
+      extend Windcharger::Attributes
+
+      attribute
+      def foo; end
+    end
+    expect(transformer_class.attributes).to eq [:foo]
+  end
+
+  it "appropriately does and does not add multiple methods" do
+    transformer_class = Class.new do
+      extend Windcharger::Attributes
+
+      attribute
+      def foo; end
+
+      def bar; end
+      def baz; end
+
+      attribute
+      def qux; end
+
+      attribute
+      def foobar; end
+
+      def barbaz; end
+    end
+
+    expect(transformer_class.attributes).to eq [:foo, :qux, :foobar]
+  end
+end

data/spec/windcharger/hash_transformer_spec.rb

@@ -0,0 +1,25 @@
+require 'spec_helper'
+require 'windcharger/hash_transformer'
+
+describe Windcharger::HashTransformer do
+  describe "#transform" do
+    it "returns a hash with attribute names and return values from those methods" do
+      transformer_class = Class.new do
+        extend Windcharger::Attributes
+        include Windcharger::HashTransformer
+
+        attribute
+        def foo; 42; end
+        attribute
+        def bar; 'colorless green ideas'; end
+        def baz; end
+      end
+      transformer = transformer_class.new
+
+      expect(transformer.transform).to eq({
+        foo: 42,
+        bar: 'colorless green ideas',
+      })
+    end
+  end
+end

data/windcharger.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'windcharger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'windcharger'
+  spec.version       = Windcharger::VERSION
+  spec.authors       = ['Andrew Marshall']
+  spec.email         = ['andrew@johnandrewmarshall.com']
+  spec.description   = %q{Small library to easily make objects that transform input via many methods.}
+  spec.summary       = %q{Small library to easily make objects that transform input via many methods.}
+  spec.homepage      = 'http://johnandrewmarshall.com/projects/windcharger'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: windcharger
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Marshall
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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: Small library to easily make objects that transform input via many methods.
+email:
+- andrew@johnandrewmarshall.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/windcharger.rb
+- lib/windcharger/attributes.rb
+- lib/windcharger/hash_transformer.rb
+- lib/windcharger/version.rb
+- spec/spec_helper.rb
+- spec/windcharger/attributes_spec.rb
+- spec/windcharger/hash_transformer_spec.rb
+- spec/windcharger_spec.rb
+- windcharger.gemspec
+homepage: http://johnandrewmarshall.com/projects/windcharger
+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.1.9
+signing_key: 
+specification_version: 4
+summary: Small library to easily make objects that transform input via many methods.
+test_files:
+- spec/spec_helper.rb
+- spec/windcharger/attributes_spec.rb
+- spec/windcharger/hash_transformer_spec.rb
+- spec/windcharger_spec.rb
+has_rdoc: