usable 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 97cce0168afce1846a0d35f692a9880e517dbe7e
+  data.tar.gz: 9fde115f8e348ef8fa94f9b79f231f1dce592026
+SHA512:
+  metadata.gz: 3a19a138c0a0ddfb9a6c980cb4abaac2477f2458e95ca3a6a1bd07c6f6f6fcd1f5e53d5ce2e6c1ef08a14b3a065ce68bc817f12545a1bd59497587e39f0beab8
+  data.tar.gz: 6f8fd5859cdd1f1afac52db4555d374fc5cad64a578239358a7d6b2d4ff9eccc780281c314cf11c8324bfbbcde3367c27555dc7c14e8dfb7a1cb63deb653eda5

data/.gitignore

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

data/.ruby-gemset

@@ -0,0 +1 @@
+usable

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.4

data/Gemfile

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

data/LICENSE.md

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Ryan Buckley
+
+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,49 @@
+# Usable
+
+Rack style mixins for Ruby objects. Mount your modules like you mean it!
+
+```ruby
+class Model
+  extend Usable
+  
+  module Versionable
+    def versions
+      "Saving #{self.class.config.max_versions} versions to #{self.class.config.table_name}"
+    end
+  end
+
+  # with options hash
+  use Versionable, table_name: 'custom_versions'
+
+  # or with block
+  use Versionable do |config|
+    config.max_versions = 10
+  end
+end
+
+Model.config.table_name #=> 'custom_versions'
+Model.new.versions #=> "Saving 10 versions to custom_versions"
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'usable'
+```
+
+Or install it yourself as:
+
+    $ gem install usable
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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/[USERNAME]/usable.
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'rspec/scaffold'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "usable"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/usable/scoped.rb

@@ -0,0 +1,58 @@
+# @note UNTESTED and not included by default
+module Usable
+  class Scoped
+    module Configurable
+      def configs
+        @configs ||= Hash.new do |me, key|
+          me[key] = Usable::Config.new
+        end
+      end
+    end
+
+    def self.extended(base)
+      base.extend Configurable
+    end
+
+    def use(mod, options = {})
+      send :include, mod unless self < mod
+      if block_given?
+        yield configs[mod]
+      else
+        options.each { |k, v| configs[mod].public_send "#{k}=", v }
+      end
+    end
+  end
+end
+
+# but here's a example of how to use it
+=begin
+  module Versionable
+    def versions
+      config = self.class.configs[Versionable]
+      "Saving #{config.max_versions} versions to #{config.table_name}"
+    end
+  end
+  module Notable
+    def notes
+      config = self.class.configs[Notable]
+      "Saving #{config.max_versions} notes to #{config.table_name}"
+    end
+  end
+  class Model
+    extend Usable::Scoped
+
+  # with options hash
+    use Versionable, table_name: 'custom_versions'
+  # or with block
+    use Versionable do |config|
+      config.max_versions = 10
+    end
+    use Notable do |config|
+      config.max_versions = 20
+      config.table_name = 'custom_notes'
+    end
+  end
+  Model.config.table_name #=> 'custom_versions'
+  Model.new.versions #=> "Saving 10 versions to custom_versions"
+  Model.new.notes #=> "Saving 20 notes to custom_notes"
+=end

data/lib/usable/version.rb

@@ -0,0 +1,3 @@
+module Usable
+  VERSION = "0.1.0".freeze
+end

data/lib/usable.rb

@@ -0,0 +1,20 @@
+require "ostruct"
+require "usable/version"
+
+module Usable
+  def config
+    @config ||= Config.new
+  end
+
+  def use(mod, options = {})
+    send :include, mod unless self < mod
+    if block_given?
+      yield config
+    else
+      options.each { |k, v| config.public_send "#{k}=", v }
+    end
+  end
+
+  class Config < OpenStruct
+  end
+end

data/usable.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'usable/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "usable"
+  spec.version       = Usable::VERSION
+  spec.authors       = ["Ryan Buckley"]
+  spec.email         = ["arebuckley@gmail.com"]
+
+  spec.summary       = %q{Rack style mixins}
+  spec.description   = %q{Rack style mixins which provide a convention for passing options to your modules.}
+  spec.homepage      = "https://github.com/ridiculous/usable"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency 'bundler', '~> 1.10'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '>= 3.2', '< 4'
+  spec.add_development_dependency 'rspec-scaffold', '>= 1.0', '< 2'
+end

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: usable
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ryan Buckley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: rspec-scaffold
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Rack style mixins which provide a convention for passing options to your
+  modules.
+email:
+- arebuckley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/usable.rb
+- lib/usable/scoped.rb
+- lib/usable/version.rb
+- usable.gemspec
+homepage: https://github.com/ridiculous/usable
+licenses: []
+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: Rack style mixins
+test_files: []