hash_out 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 56a567fff415c75fb0bb97f0c334cd4a50272d02
+  data.tar.gz: b5b63f10a8e06a0883c98f23cc24aeada979bb01
+SHA512:
+  metadata.gz: 49bce4736f8707cc08c3ac511dcaa120681524c60de987c91f67580bef6b294e460b762f605fb552a13e83f89447f307e642a310ac3ed9f1c754f78cb280260b
+  data.tar.gz: 8c46716e629007476f50f423acee955e64fd4eaadd3ff06674f7ee5f05d1dbbb8b30d5e50c10fac507d85c93fc3b12e3831403d9e1e48a76be835f079963b3d9

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - rbx-19mode
+  - jruby-19mode
+script: bundle exec rake

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    hash_out (0.1.0)
+      rake
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.0.6)
+    minitest-spec-expect (0.1.3)
+      minitest (~> 5.0)
+    rake (10.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hash_out!
+  minitest-spec-expect (~> 0.1)

data/README.md

@@ -0,0 +1,94 @@
+# hash_out
+
+[![Build Status](https://travis-ci.org/davejachimiak/hash_out.png?branch=master)](https://travis-ci.org/davejachimiak/hash_out)
+
+Include `HashOut` to your class and convert your object to a hash with the `#hash_out` method.
+
+## Install
+Add to your Gemfile:
+```ruby
+gem 'hash_out', '~> 0.1'
+```
+
+Or install it from the command line:
+```sh
+$ gem install hash_out
+```
+
+## Usage
+1. `require 'hash_out'`.
+2. Include `HashOut` in your class.
+3. If desired, exclude methods from `#hash_out` by adding `exclude_from_hash_out` to them.
+4. Call `#hash_out` on the instance to return a hash of method names and their values.
+
+**`#hash_out` automatically excludes private methods and methods that require arguments.**
+
+```ruby
+require 'hash_out'
+
+class Movie
+  include HashOut
+
+  def title
+    'Fire Walk With Me'
+  end
+
+  def director
+    exclude_from_hash_out
+    'David Lynch'
+  end
+
+  def available_instantly? catalog=TerribleStreamingService.new
+    catalog.available_instantly? self
+  end
+
+  def has_actor? actor
+    actors.include? actor
+  end
+
+  def chance_of_sequel? existing_sequels, strategy=FutureSequelStrategy
+    strategy.new(self, existing_sequels).chance > 0.5
+  end
+
+  private
+
+  def actors
+    ['Sheryl Lee', 'David Bowie', 'Ray Wise']
+  end
+end
+
+movie = Movie.new
+movie.hash_out
+# => {:title=>"Fire Walk With Me", :available_instantly?=>false}
+
+```
+
+## Contribute
+1. Fork the repo.
+2. Create a branch.
+3. Add specs and code.
+4. Ensure the specs are green (`$ rake`)
+5. Open a pull request.
+
+## License
+The MIT License (MIT)
+
+Copyright (c) 2013 Dave Jachimiak
+
+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/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+desc 'Run the tests'
+task :default => :test
+
+desc 'Run the tests'
+Rake::TestTask.new do |t|
+  t.pattern = 'spec/**/*.rb'
+end

data/hash_out.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+
+$:.push File.expand_path("../lib", __FILE__)
+require 'hash_out/version'
+
+Gem::Specification.new do |s|
+  s.name          = 'hash_out'
+  s.description   = 'Easily convert public methods to a hash.'
+  s.summary       = "hash_out adds a method to your class' instance and returns hash of public method names and values."
+  s.authors       = ['Dave Jachimiak']
+  s.email         = 'dave.jachimiak@gmail.com'
+  s.homepage      = 'http://github.com/davejachimiak/hash_out'
+  s.version       = HashOut::VERSION
+  s.license       = 'MIT'
+  s.files         = `git ls-files`.split("\n").reject do |file_name|
+    /\.gem$/.match file_name
+  end
+  s.test_files    = `git ls-files -- spec`.split("\n")
+  s.require_paths = ['lib']
+
+  s.add_dependency 'rake'
+  s.add_development_dependency 'minitest-spec-expect', '~> 0.1'
+end

data/lib/hash_out/version.rb

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

data/lib/hash_out.rb

@@ -0,0 +1,48 @@
+module HashOut
+  require 'set'
+
+  def hash_out
+    set_hash_out
+    delete_exclusions
+    @hash_out
+  end
+
+  protected
+
+  def exclude_from_hash_out
+    excluded_method = caller_method_sym caller.first
+    exclusions.add excluded_method
+  end
+
+  private
+
+  def set_hash_out
+    @hash_out = Hash[interesting_methods_and_values]
+  end
+
+  def interesting_methods_and_values
+    methods_requiring_no_arguments.map do |method_name|
+      name_value_pair method_name
+    end
+  end
+
+  def methods_requiring_no_arguments
+    public_methods(false).select { |m| [-1, 0].include? method(m).arity }
+  end
+
+  def name_value_pair method_name
+    [method_name, send(method_name)]
+  end
+
+  def delete_exclusions
+    exclusions.each { |exclusion| @hash_out.delete exclusion }
+  end
+
+  def exclusions
+    @exclusions ||= Set.new
+  end
+
+  def caller_method_sym caller_string
+    caller_string.match(/`(.*)'/)[1].to_sym
+  end
+end

data/spec/lib/integration_spec.rb

@@ -0,0 +1,109 @@
+require_relative '../../lib/hash_out'
+require 'minitest/autorun'
+require 'minitest/spec/expect'
+
+describe 'HashOut#hash_out' do
+  class Baller
+    include HashOut
+
+    def mood
+      :ballin
+    end
+
+    def height
+      :tall
+    end
+  end
+
+  it 'returns a hash of name-values' do
+    baller   = Baller.new
+    hash_out = {
+      mood:   baller.mood,
+      height: baller.height
+    }
+
+    expect(baller.hash_out).to_equal hash_out
+  end
+
+  class ShotCaller
+    include HashOut
+
+    def front
+      :chillin
+    end
+
+    private
+
+    def real_mood
+      :nervous
+    end
+  end
+
+  it 'ignores private methods' do
+    shot_caller = ShotCaller.new
+    hash_out    = { front: shot_caller.front }
+
+    expect(shot_caller.hash_out).to_equal hash_out
+  end
+
+  class Brawler
+    include HashOut
+
+    def fighting?
+      true
+    end
+
+    def pancakes
+      exclude_from_hash_out
+      'yes please'
+    end
+  end
+
+  it 'ignores public methods that declare exclusion from public hash' do
+    brawler  = Brawler.new
+    hash_out = { fighting?: brawler.fighting? }
+
+    expect(brawler.hash_out).to_equal hash_out
+  end
+
+  class Beans; end;
+  class Grinder
+    require 'ostruct'
+    include HashOut
+
+    def initialize
+      @beans = Beans.new
+    end
+
+    def grind settings, beans=@beans
+      with_settings(settings) do
+        beans.krush
+      end
+    end
+
+    def clean materials
+      clean_with materials
+    end
+
+    def blade edge=:sharp
+      edge
+    end
+
+    private
+
+    def with_settings settings
+      @settings = settings
+      yield self
+    end
+
+    def clean_with
+    end
+  end
+
+  it 'ignores public methods that require arguments' do
+    grinder  = Grinder.new
+    hash_out = { blade: grinder.blade }
+
+    expect(grinder.hash_out).to_equal hash_out
+  end
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: hash_out
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Dave Jachimiak
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: minitest-spec-expect
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: Easily convert public methods to a hash.
+email: dave.jachimiak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- hash_out.gemspec
+- lib/hash_out.rb
+- lib/hash_out/version.rb
+- spec/lib/integration_spec.rb
+homepage: http://github.com/davejachimiak/hash_out
+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.0.2
+signing_key: 
+specification_version: 4
+summary: hash_out adds a method to your class' instance and returns hash of public
+  method names and values.
+test_files:
+- spec/lib/integration_spec.rb