openhouse 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee0a6310ebf083c1251740b589f1e9d3930cefeb
+  data.tar.gz: 2e51ef43148b2878f38a9570d4282b4d34d11f81
+SHA512:
+  metadata.gz: f34c80fc62239c42cdd15c4d56ed20526e4055d7c9980f6125d2c1a736d26022f599be8f3b9c934c15a26d1b469e451e604980f945d97d94eda40c43a97adea0
+  data.tar.gz: 70a03ad14931b19a9d9d95b45e6534a37785c890ef781635c1cdff830ed4a38485e17720fca99684d1425ded947f46c7bdc83798c60163abe53c5c46c37d5601

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.travis.yml

@@ -0,0 +1,10 @@
+sudo: false
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
+  - 2.3.0
+  - 2.4.0
+before_install: gem install bundler -v 1.15.1

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# OpenHouse Changelog
+
+All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning][Semver].
+
+## [Unreleased]
+
+* Your contribution here!
+
+## 0.0.1 (2017-06-20)
+
+* Initial release
+
+[Semver]: http://semver.org
+[Unreleased]: https://github.com/eugeniobruno/openhouse/compare/v0.0.1...HEAD

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at eugeniobruno@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eugenio Bruno
+
+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,69 @@
+# OpenHouse
+
+OpenHouse provides a module which simplifies implementing the Visitor design pattern on a type hierarchy.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'openhouse'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install openhouse
+
+## Usage
+
+Here is a simple example:
+
+```ruby
+class EmperorPenguin
+
+  include OpenHouse::Acceptor
+
+  attr_reader :weight
+
+  def initialize(weight)
+    @weight = weight
+  end
+
+end
+
+class AnimalAnnouncerVisitor
+
+  def visit_emperor_penguin(emperor_penguin)
+    "This is an emperor penguin that weights #{emperor_penguin.weight} kg."
+  end
+
+end
+
+animal  = EmperorPenguin.new(42)
+visitor = AnimalAnnouncerVisitor.new
+
+animal.accept_visitor(visitor)
+```
+
+An example with a full type hierarchy that shows more features can be found in the test files.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/eugeniobruno/openhouse. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,17 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.test_files = FileList['test/**/test_*.rb']
+end
+
+task default: :test
+
+desc 'Start a REPL session'
+task :console do
+  require 'openhouse'
+  require 'pry'
+  ARGV.clear
+  Pry.start
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'openhouse'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require 'pry'
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/openhouse/acceptor.rb

@@ -0,0 +1,37 @@
+module OpenHouse
+  module Acceptor
+    def accept_visitor(visitor, *args)
+      visitor.public_send("visit_#{own_acceptor_type_id}", self, *args)
+    end
+
+    def accept_visitor_in_ancestry(visitor, *args)
+      accept_visitor_in_modules(visitor, self.class.ancestors, *args)
+    end
+
+    private
+
+    def own_acceptor_type_id
+      acceptor_type_id(self.class)
+    end
+
+    def acceptor_type_id(modul)
+      if modul.const_defined?(:ACCEPTOR_TYPE_ID, false)
+        modul::ACCEPTOR_TYPE_ID
+      else
+        OpenHouse.simple_inflector.underscored_demodulized(modul.name).to_sym
+      end
+    end
+
+    def accept_visitor_in_modules(visitor, modules, *args)
+      modules.each do |modul|
+        method_name_suffix = acceptor_type_id(modul)
+        if visitor.respond_to?("visit_#{method_name_suffix}")
+          return visitor.public_send("visit_#{method_name_suffix}", self, *args)
+        end
+      end
+
+      error_message = "undefined method 'visit_[acceptor_type_id]' for #{visitor.class} for any of these modules: #{modules}"
+      raise NoMethodError, error_message
+    end
+  end
+end

data/lib/openhouse/simple_inflector.rb

@@ -0,0 +1,22 @@
+module OpenHouse
+  class SimpleInflector
+    def demodulized(module_name)
+      module_name.split('::').last
+    end
+
+    def underscored(module_name)
+      return module_name.downcase if module_name.upcase == module_name
+
+      ret = module_name                    # MyModuleName     ABCName
+            .gsub(/([A-Z])/, '_\1'.freeze) # _My_Module_Name  _A_B_C_Name
+            .gsub(/([A-Z])_([A-Z])_/, '\1\2'.freeze) #        _ABC_Name
+            .downcase                      # _my_module_name  _abc_name
+
+      ret.start_with?('_') ? ret[1..-1] : ret
+    end
+
+    def underscored_demodulized(module_name)
+      underscored(demodulized(module_name))
+    end
+  end
+end

data/lib/openhouse/version.rb

@@ -0,0 +1,3 @@
+module OpenHouse
+  VERSION = '0.0.1'.freeze
+end

data/lib/openhouse.rb

@@ -0,0 +1,10 @@
+require 'openhouse/version'
+
+require 'openhouse/simple_inflector'
+require 'openhouse/acceptor'
+
+module OpenHouse
+  def self.simple_inflector
+    @simple_inflector ||= SimpleInflector.new
+  end
+end

data/openhouse.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'openhouse/version'
+
+Gem::Specification.new do |spec|
+  spec.name     = 'openhouse'
+  spec.version  = OpenHouse::VERSION
+  spec.date     = '2017-06-20'
+  spec.authors  = ['Eugenio Bruno']
+  spec.email    = ['eugeniobruno@gmail.com']
+
+  spec.summary  = 'OpenHouse simplifies implementing the Visitor design pattern.'
+  spec.homepage = 'https://github.com/eugeniobruno/openhouse'
+  spec.license  = 'MIT'
+
+  spec.files    = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir           = 'bin'
+  spec.executables      = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.test_files       = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths    = ['lib']
+  spec.extra_rdoc_files = %w[LICENSE.txt README.md CODE_OF_CONDUCT.md CHANGELOG.md]
+
+  spec.required_ruby_version = '>= 1.9.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'minitest-bender', '~> 0.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'pry-byebug', '~> 3.4'
+
+  if RUBY_VERSION < '2'
+    spec.add_development_dependency 'term-ansicolor', '~> 1.3.0'
+    spec.add_development_dependency 'tins', '~> 1.6.0'
+    spec.add_development_dependency 'json', '~> 1.8'
+  end
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: openhouse
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Eugenio Bruno
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-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.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-bender
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+description: 
+email:
+- eugeniobruno@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+- CODE_OF_CONDUCT.md
+- CHANGELOG.md
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/openhouse.rb
+- lib/openhouse/acceptor.rb
+- lib/openhouse/simple_inflector.rb
+- lib/openhouse/version.rb
+- openhouse.gemspec
+homepage: https://github.com/eugeniobruno/openhouse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: OpenHouse simplifies implementing the Visitor design pattern.
+test_files: []