black_box 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc527b8e8f267ec84decb84307d02f857ab94cdc
+  data.tar.gz: a16c109049817a6a6d37ab757770adb45d532abf
+SHA512:
+  metadata.gz: f8ff39cb11ebd876a3103fb32ca8accadb12ac9063b87b7090399fa3841a45c628018d85ea6b28dbc386d35843e0fc3b74eb64fdfc3f7b11ada8b6ddf77252da
+  data.tar.gz: e7e467835f1ce1af529e3d497cc61bc3a4fd21102cd7f94470a67e1ff14153487783d1151ab9a978b544a7a87360e8b97c778c545f55cc36b0b692d7c07209a8

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/BlockLength:
+  Max: 80
+Metrics/LineLength:
+  Max: 80
+
+ClassAndModuleChildren:
+  Enabled: false
+EmptyLinesAroundBlockBody:
+  Enabled: false
+EmptyLinesAroundClassBody:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at gannon.mcgibbon@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Gannon McGibbon
+
+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 @@
+# BlackBox
+
+[![Build Status](https://travis-ci.org/gmcgibbon/black_box.svg?branch=master)](https://travis-ci.org/gmcgibbon/black_box)
+
+Static wrappers for instantiated classes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'black_box'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install black_box
+
+## Usage
+
+1. Make a box class that extends from `BlockBox::Base` (or includes `BlackBox::Concern`).
+2. Specify a subject class with `.subject`.
+3. Define initialization parameters with `.accept`.
+4. Define methods to delegate with `.expose`.
+5. Set initialization parameters with `.configure`.
+
+```ruby
+# Require your subject
+require 'api_object'
+
+# Make your black box
+class Api < BlackBox::Base
+
+  subject ApiObject
+
+  accept :token, :ssl
+
+  expose :find
+
+end
+
+# Configure your black box
+Api.configure do |api|
+  api.token = 'my_api_token'
+  api.ssl   = true
+end
+
+# Use your black box
+Api.find(12)
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/gmcgibbon/black_box. 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'black_box'
+
+# 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

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/black_box.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'black_box/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'black_box'
+  spec.version       = BlackBox::VERSION
+  spec.authors       = %w(Gannon\ McGibbon)
+  spec.email         = %w(gannon.mcgibbon@gmail.com)
+
+  spec.summary       = 'Static wrappers for instantiated classes'
+  spec.description   = <<-DESC.strip.chomp
+  BlackBox turns any instantiated class into a singleton static class.
+  DESC
+  spec.homepage      = 'https://github.com/gmcgibbon/black_box'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport', '~> 4.2'
+
+  spec.add_development_dependency 'bundler',          '~> 1.12'
+  spec.add_development_dependency 'rake',             '~> 10.0'
+  spec.add_development_dependency 'rspec',            '~> 3.0'
+  spec.add_development_dependency 'shoulda-matchers', '~> 3.1'
+  spec.add_development_dependency 'rubocop',          '~> 0.44'
+  spec.add_development_dependency 'analytics-ruby'
+  spec.add_development_dependency 'pubnub'
+end

data/lib/black_box.rb

@@ -0,0 +1,6 @@
+require 'singleton'
+require 'active_support'
+
+require 'black_box/version'
+require 'black_box/concern'
+require 'black_box/base'

data/lib/black_box/base.rb

@@ -0,0 +1,22 @@
+# Includes BlackBox::Concern, cannot be instantiated.
+class BlackBox::Base
+
+  def initialize
+    raise abstract_error
+  end
+
+  class << self
+
+    private
+
+    def inherited(subclass)
+      subclass.include BlackBox::Concern
+    end
+  end
+
+  def abstract_error
+    NotImplementedError.new <<-ERROR.strip.chomp
+    #{self.class} is an abstract class and cannot be instantiated.
+    ERROR
+  end
+end

data/lib/black_box/concern.rb

@@ -0,0 +1,58 @@
+# Include this concern to make your class a black box!
+module BlackBox::Concern
+  extend ActiveSupport::Concern
+
+  BOX_ATTRIBUTES = %i(box_attributes box_methods box_class).freeze
+
+  included do
+    include Singleton
+
+    BOX_ATTRIBUTES.each do |attribute|
+      cattr_accessor(attribute) do
+        [] unless %i(box_class).include? attribute
+      end
+    end
+
+    attr_accessor :subject
+  end
+
+  class_methods do
+
+    def subject(klass)
+      self.box_class = klass
+    end
+
+    def accept(*attributes)
+      box_attributes.push(*attributes)
+      box_attributes.uniq!
+      cattr_accessor(*attributes)
+    end
+
+    def expose(*methods)
+      box_methods.push(*methods)
+      box_methods.uniq!
+      singleton_class.class_eval { delegate(*methods, to: :instance) }
+      delegate(*methods, to: :subject)
+    end
+
+    def configure
+      yield self if block_given?
+    end
+  end
+
+  private
+
+  def initialize
+    initialize_subject
+  end
+
+  def initialize_params
+    box_attributes.map do |key|
+      [key, send(key)]
+    end.to_h
+  end
+
+  def initialize_subject
+    self.subject = box_class.new initialize_params
+  end
+end

data/lib/black_box/version.rb

@@ -0,0 +1,3 @@
+module BlackBox
+  VERSION = '1.0.1'.freeze
+end

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: black_box
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Gannon McGibbon
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-11-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.44'
+- !ruby/object:Gem::Dependency
+  name: analytics-ruby
+  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: pubnub
+  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: BlackBox turns any instantiated class into a singleton static class.
+email:
+- gannon.mcgibbon@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- black_box.gemspec
+- lib/black_box.rb
+- lib/black_box/base.rb
+- lib/black_box/concern.rb
+- lib/black_box/version.rb
+homepage: https://github.com/gmcgibbon/black_box
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Static wrappers for instantiated classes
+test_files: []