register 0.5.3

data/.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+- 2.4.1
+- 2.3.4
+- 2.2.7
+before_install: gem install bundler -v 1.15.4
+notifications:
+  email:
+    recipients:
+    - kigster@gmail.com
+    on_success: change
+    on_failure: always
+  slack:
+    rooms:
+      secure: GcACCHmcmo99lYE5dgt2TmY4YIPMWr75q0Bkm4Lddegq/1eMXgcZDz00j8iHWtnveyJSjEUpZFQ9uyx+P7dvxT7D5gl43arKZEylS4vMRg9QRgZu7/ROrXbJtrUyKulFRUTdFrmOiK9nDKpAzlvLvMKC4kaQnn88Xtu9pYMU8y4n5fCtl29gZM9ZjVbrBBvV/SumnTDLla2oQ7oFgUZdZhQZ1qsevYknxNq4eIcvPDjbon+bovfsIISEVRSNo2C3yjO+mqWKed3jfuCA4taAZ8/aVVFEKURMH10HFms1CiC3lE/gF4YfBXsqKpjnB+bKjBcWox2FQrp96FulMEIfkKQrnuncO96o7MGHX9oNqKSMoycf3+SZFwNa+5Mfq7SBepbHYCoU7/ow31UTyStrc5idG19XzYgI85yjQHdzQN299Xf0O8cGf9q9qAu7rS7JlM3ekR+3rZYO+OxNYTF8rcW1fYIj6GKcbsV8BvuhAVQRFOsk/ibcIb2N7rGVd/ZbU4HAk3RE1ywt+XowinpIHktu2PQUPDNpgRQwM6xqZHO/7s9r7oW0ULmZCMLZ9CMKNjKzrQ9wfh90+v+FiEiUKsaVj4cCwF3PvhVYvxU2AKbCeHtSEb7K6to86+DYNoIKnGH1ryKoyCtyOTZpNMLGFt34Msv7WfEylhG+DpVMvkM=
+addons:
+  code_climate:
+    repo_token:
+      secure: B1l5OpGEPsAzThXW1UnojquRMH/oIO1QPd/sgB0y0ymwU6l6wAWPiN5/JwGNJPSl2h/EwrK2aTroP7fUsn7J5UcGh8yaerMwNKbUXo5/VNVfMz0ZVzNwaWPjMdDtuSolhabwPMPP1afdm2YT+IZwrid8zRjSB8/OsSPr0LCrciftVDiaN3XMfXMIheEOUokkH/X+m+PxZlYbL1v36D+CyhhulItnlEbhavK4fzN8bpkno2uK/IvLmheUeXCGvHdxhHE04mXYoEZGP87PCbV5vJ9hiFMXx9TiN2F51Z0Qr0F07MQY/l/svwpWUsnGRL3xaM58a/JxDG7Z/Qipt+4UId67xXSMmibHzW2kcJo71odS8rXUkwuxHuYFbHBQvBstjimc4YFfrth8YnVUnFIv/a3y8bE3+ESt++LRj2MlK6trisxOrCwJtDNJq5fJw6evdGOogTQ186oaBR8/6pPbmOrZHKc0aCrguWvVc3NHwD9oZNoPqKZ5vU/5RysDfx9dljfTR1BoMxjs0UN+nlMryFXRTyNgkk0YsLD3VrxjLNl6ykcO7nYgxiyuWOiXxTzGai5NU4ihbSFqpFeQ973iEnAGlnX2Uz32rX/ZPwJeqpVRZZkmZyUZo4cFjYa/yKwCTIgx3m2zAfV6VqwEs6USSq1OhEEKVgFw+rfo8Bw2cyw=
+after_success:
+- bundle exec codeclimate-test-reporter

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |_repo_name| 'https://github.com/kigster/register-rb' }
+
+# Specify your gem's dependencies in register.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Konstantin Gredeskoul
+
+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,99 @@
+[![Build Status](https://travis-ci.org/kigster/register.svg?branch=master)](https://travis-ci.org/kigster/register)
+[![Code Climate](https://codeclimate.com/github/kigster/register/badges/gpa.svg)](https://codeclimate.com/github/kigster/register)
+[![Test Coverage](https://codeclimate.com/github/kigster/register/badges/coverage.svg)](https://codeclimate.com/github/kigster/register/coverage)
+[![Issue Count](https://codeclimate.com/github/kigster/register/badges/issue_count.svg)](https://codeclimate.com/github/kigster/register)
+
+
+# *Register* —  A Module Method Factory Pattern
+
+**Register** is a tiny library that can be included in a module that is to become a Façade to several application globals via auto-generated module-level methods.
+
+A good example is a register of several connections to either *Redis* or *MemCached*, for example you might have a short-term memcached connection with a short default expiration TTL, and a longer-living one that requires sweeping to clean. You could use `Register` to wrap access to these singletons in `MyModule.cache_type` accessors.
+
+## Usage
+
+### Creating a Register
+
+To create a register module, just include `Register` in any ruby module: 
+
+```ruby
+require 'register'
+
+module Cache
+  include Register
+end
+```
+
+### Storing Items in the Register
+
+To add items to the register, call the `<<` method, passing an array of identifiers, followed by the actual item to store. In other words, the last items of the argument array is the actual item stored against each of the identifiers passed before it.
+
+```ruby
+
+# Our "item" will be a simple cache store with a name:
+CacheStore = Struct.new(:name)
+
+# Register items associated with any one of the identifiers
+Cache.register :planetary, :cosmic, CacheStore.new(:saturn)
+
+# You can use << syntax which is an alias to #register, but 
+# then use << to append the actual item
+Cache.<< %i[primary main rails deploy] << CacheStore.new(:primary)
+
+Cache.<< %i[durable secondary] << CacheStore.new(:secondary)
+```
+
+### Looking up (Fetching) Items from the Register
+
+There are two ways to fetch the previously-stored item:
+
+  1. Using the `#for(:name)` method
+  2. Using the auto-generated module-level accessor
+  
+In the first example, we would call `Cache.for(:planetary)` to fetch the cache store, while in the second case we would call `Cache.planetary` method, which provides additional guarantees: if the method is not there, something is definitely wrong.  
+
+```ruby
+Cache.planetary.name should eq(:saturn)
+Cache.primary === Cache.main === Cache.rails === Cache.deploy
+Cache.durable.name = 'DURABLE'
+Cache.secondary.name # => 'DURABLE'
+```
+
+Here is a more complete RSPec example:
+
+```ruby
+require 'rspec'
+require 'rspec/its'
+RSpec.describe Cache do
+  subject(:cache) { Cache }
+  its(:planetary) { should eq CachStore.new(:saturn) }    
+  its(:deploy) { should eq CachStore.new(:primary) }    
+  its(:durable) { should eq CachStore.new(:secondary) }
+  it 'should also respond to #for' do
+    expect(cache.for(:secondary)).to eq(CacheStore(:secondary))      
+  end
+end
+```
+    
+## Installation
+
+    gem install register 
+
+## Note on Patches and Pull Requests
+ 
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history. If you want to have your own version, that is fine but bump  version in a commit by itself I can ignore when I pull.
+ * Send a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright &copy; 2017 Konstantin Gredeskoul. See LICENSE for details.
+
+## Contributors
+
+ * [Konstantin Gredeskoul](https://github.com/kigster)
+ 
+ 
+

data/Rakefile

@@ -0,0 +1,27 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
+
+def shell(*args)
+  puts "running: #{args.join(' ')}"
+  system(args.join(' '))
+end
+
+task :permissions do
+  shell('rm -rf pkg/')
+  shell('chmod -v o+r,g+r * */* */*/* */*/*/* */*/*/*/* */*/*/*/*/*')
+  shell('chmod -v o+x,g+x exe/* bin/*')
+  shell("find . -type d -exec chmod o+x,g+x {} \\;")
+end
+
+task :build => :permissions
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.files = %w(lib/**/*.rb exe/*.rb - README.md LICENSE)
+  t.options.unshift('--title','Register - An easy way to create Mudule-level accessors to global resources')
+  t.after = ->() { exec('open doc/index.html') }
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "register"
+
+# 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,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/lib/register.rb

@@ -0,0 +1,76 @@
+require 'register/version'
+require 'colored2'
+module Register
+  class RegisterError < StandardError; end
+  class AlreadyRegisteredError < RegisterError; end
+  class NoSuchIdentifierError < RegisterError; end
+  class ReservedIdentifierError < RegisterError; end
+
+  module DummyModule
+  end
+
+  RESERVED = (DummyModule.methods << %i[for register << add_method]).flatten!.freeze
+
+  def self.included(klass)
+    klass.instance_eval do
+      @store = Hash.new
+      @mutex = Mutex.new
+      class << self
+        attr_accessor :store, :mutex
+        def <<(*names, &block)
+          names.flatten!
+          item = block ? yield(self) : names.pop
+          validate_existing_keys!(names)
+          validate_reserved_keys!(names)
+          names.each do |n|
+            store[n] = item
+            add_method(n)
+          end
+        end
+
+        alias register <<
+
+        def for(id)
+          unless store.key?(id)
+            raise NoSuchIdentifierError,
+                  "No identifier #{id} found in the registry"
+          end
+          store[id]
+        end
+
+        private
+
+        def add_method(id)
+          return unless id.is_a?(Symbol)
+          @mutex.synchronize do
+            unless self.respond_to?(id)
+              line_no     = __LINE__
+              method_defs = %Q!
+              def self.#{id}
+                store[:#{id}]
+              end\n!
+              module_eval method_defs, __FILE__, line_no
+            end
+          end
+        end
+
+        def validate_reserved_keys!(names)
+          reserved = names.select { |n| RESERVED.include?(n) }
+          unless reserved.empty?
+            raise ReservedIdentifierError, "The following keys are reserved and can not be used: #{reserved}"
+          end
+        end
+
+        def validate_existing_keys!(names)
+          already = names.select { |n| store.key?(n) }
+          unless already.empty?
+            raise AlreadyRegisteredError, "The following keys are already in the registry: #{already}"
+          end
+        end
+
+
+      end
+    end
+  end
+end
+

data/lib/register/version.rb

@@ -0,0 +1,3 @@
+module Register
+  VERSION = '0.5.3'.freeze
+end

data/register.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'register/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'register'
+  spec.version       = Register::VERSION
+  spec.authors       = ['Konstantin Gredeskoul']
+  spec.email         = ['kigster@gmail.com']
+
+  spec.summary   = %q{This is a simple module-level registry for application globals. Use it to wrap global connection pools, memcached connections, redis, even database connections, and register them within a top-level namespace module of your application. For example, instead of doing Rails.cache you could be doing MyApp.rails_cache or MyApp.redis_cache, etc.}
+  spec.description   = %q{This is a simple module-level registry for application globals. Use it to wrap global connection pools, memcached connections, redis, even database connections, and register them within a top-level namespace module of your application. For example, instead of doing Rails.cache you could be doing MyApp.rails_cache or MyApp.redis_cache, etc.}
+  spec.homepage      = 'https://github.com/kigster/register'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split($\).reject{ |f| f.match(%r{^(doc|spec|coverage|pkg)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'colored2'
+  spec.add_development_dependency 'yard'
+  spec.add_development_dependency 'awesome_print'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-its'
+end

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: register
+version: !ruby/object:Gem::Version
+  version: 0.5.3
+platform: ruby
+authors:
+- Konstantin Gredeskoul
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: codeclimate-test-reporter
+  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: colored2
+  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: yard
+  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: awesome_print
+  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: 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: 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: rspec-its
+  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: This is a simple module-level registry for application globals. Use it
+  to wrap global connection pools, memcached connections, redis, even database connections,
+  and register them within a top-level namespace module of your application. For example,
+  instead of doing Rails.cache you could be doing MyApp.rails_cache or MyApp.redis_cache,
+  etc.
+email:
+- kigster@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/register.rb
+- lib/register/version.rb
+- register.gemspec
+homepage: https://github.com/kigster/register
+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.6.11
+signing_key: 
+specification_version: 4
+summary: This is a simple module-level registry for application globals. Use it to
+  wrap global connection pools, memcached connections, redis, even database connections,
+  and register them within a top-level namespace module of your application. For example,
+  instead of doing Rails.cache you could be doing MyApp.rails_cache or MyApp.redis_cache,
+  etc.
+test_files: []