hesburgh-lib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 19be6eece64491b61c05c61eb9d8deb705d2b6c2
+  data.tar.gz: cf13adff46b6df8cc67b20cb83860e8c50942aca
+SHA512:
+  metadata.gz: dd540b822d3f937261a94a1463443130214b936e7ce56e6de0dd8aacc6c68288b5a9ceb56d892f86a7a950ab06aa88d4d15e66bb4fe0b8787d376e17d06bc620
+  data.tar.gz: 52541e39a80a3a5a4945b9e24c5363a204a10d332f115069ddfa19abc06c263512c31d69f37657096b5c6975fdd0902af6fe0ee6845a4add8eef39ab389abb86

data/LICENSE

@@ -0,0 +1,14 @@
+##########################################################################
+# Copyright 2014 University of Notre Dame
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

data/README.md

@@ -0,0 +1,14 @@
+# Hesburgh::Lib
+
+[![Build Status](https://travis-ci.org/ndlib/hesburgh-lib.png?branch=master)](https://travis-ci.org/ndlib/hesburgh-lib)
+[![Code Climate](https://codeclimate.com/github/ndlib/hesburgh-lib.png)](https://codeclimate.com/github/ndlib/hesburgh-lib)
+[![Coverage Status](https://img.shields.io/coveralls/ndlib/hesburgh-lib.svg)](https://coveralls.io/r/ndlib/hesburgh-lib)
+[![Documentation Status](http://inch-ci.org/github/ndlib/hesburgh-lib.svg?branch=master)](http://inch-ci.org/github/ndlib/hesburgh-lib)
+[![APACHE 2 License](http://img.shields.io/badge/APACHE2-license-blue.svg)](./LICENSE)
+
+A toolbox of code that may be reusable.
+
+## Usage
+
+None of the classes in this gem should be autoloaded.
+It is up to *you, the developer,* to explicitly require the class.

data/bin/update-dependency

@@ -0,0 +1,84 @@
+#!/usr/bin/env ruby -wU
+
+# *****************************************************************************
+#
+# CONFIGURATION OPTIONS
+#
+# *****************************************************************************
+
+CONFIG_KEYS = [:REPOSITORY_PATH].freeze
+
+REPOSITORY_PATH = ENV.fetch('REPOSITORY_PATH') { Dir.pwd }
+
+# *****************************************************************************
+#
+# HELP OPTIONS
+#
+# *****************************************************************************
+
+if ARGV.grep(/^-+h(elp)?$/i).size > 0
+  $stdout.puts ""
+  $stdout.puts "$ #{File.basename(__FILE__)} <gem1> <gem2>"
+  $stdout.puts ""
+  $stdout.puts "This script will update the given gem dependency, one at a time, and commit the"
+  $stdout.puts "change."
+  $stdout.puts ""
+  $stdout.puts "Current Configuration:"
+  CONFIG_KEYS.each do |key|
+    $stdout.puts "\t#{key}='#{Object.const_get(key)}'"
+  end
+  $stdout.puts ""
+  $stdout.puts "You can override the configuration option by adding the corresponding"
+  $stdout.puts "ENV variable."
+  $stdout.puts ""
+  $stdout.puts "Example:"
+  $stdout.puts "$ REPOSITORY_PATH=/path/to/repository #{File.basename(__FILE__)}"
+  exit(0)
+end
+
+# *****************************************************************************
+#
+# GUARD CONDITIONS
+#
+# *****************************************************************************
+
+GEM_NAMES = ARGV
+
+# Guard that we have a clean working directory
+if `cd #{REPOSITORY_PATH} && git status --porcelain`.strip.size > 0
+  $stderr.puts "Repository @ #{REPOSITORY_PATH} did not have a clean working directory"
+  exit!(2)
+end
+
+GEM_NAMES.each do |gem_name|
+  # Guard that the update can happen
+  unless system("cd #{REPOSITORY_PATH} && bundle update #{gem_name}")
+    $stderr.puts "Unable to update #{gem_name}. See previous output."
+    exit!(3)
+  end
+
+  # Commit the changes
+  `cd #{REPOSITORY_PATH}; git add Gemfile.lock`
+
+  path_to_commit_message = File.expand_path(File.join(REPOSITORY_PATH, '../COMMIT.msg'))
+  begin
+    File.open(path_to_commit_message, 'w+') do |file|
+      file.puts "Updating #{gem_name} dependency"
+      file.puts ""
+
+      message = "`$ #{File.basename(__FILE__)} #{gem_name}`"
+      CONFIG_KEYS.each_with_object(message) do |key, mem|
+        mem = "#{key}=\"#{ENV[key.to_s]}\" #{mem}" if ENV.key?(key.to_s)
+        mem
+      end
+      file.puts message
+    end
+    $stdout.puts `cd #{REPOSITORY_PATH} && git commit -F #{path_to_commit_message}`
+  ensure
+    begin
+      File.unlink(path_to_commit_message)
+    rescue true
+      # If it doesn't exist don't worry
+    end
+  end
+end

data/hesburgh-lib.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hesburgh/lib/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "hesburgh-lib"
+  spec.version       = Hesburgh::Lib::VERSION
+  spec.authors       = ["Jeremy Friesen"]
+  spec.email         = ["jeremy.n.friesen@gmail.com"]
+  spec.summary       = %q{A toolbox of code that may be reusable.}
+  spec.description   = %q{A toolbox of code that may be reusable.}
+  spec.homepage      = "https://github.com/ndlib/hesburgh-lib"
+  spec.license       = "APACHE2"
+
+  spec.files         = `git ls-files -z -- bin/* lib/* LICENSE README.md hesburgh-lib.gemspec`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec-given", "~> 3.5"
+  spec.add_development_dependency "rubocop", "~> 0.27"
+  spec.add_development_dependency "activesupport", ">= 3.0"
+end

data/lib/hesburgh/lib/controller_with_runner.rb

@@ -0,0 +1,78 @@
+require 'active_support/concern'
+require 'active_support/core_ext/class/attribute'
+require 'active_support/core_ext/string/inflections'
+
+module Hesburgh
+  module Lib
+    # Exposes a way for connecting a set of Runners into your application.
+    # A runner allows you to tease out Action level logic into its own custom
+    # class.
+    #
+    # @see Hesburgh::Lib::Runner
+    module ControllerWithRunner
+      extend ActiveSupport::Concern
+
+      included do
+        # Because yardoc's scope imperative does not appear to work, I'm pushing the
+        # comments into the class definition
+        class << self
+          # @!attribute [rw] runner_container
+          #   So you can specify where you will be finding an action's Runner
+          #   class.
+          #
+          #   @see #run
+        end
+        class_attribute :runner_container
+      end
+
+      # So you can more easily decouple the controller's command behavior and
+      # response behavior.
+      #
+      # @example
+      #   def index
+      #     run(specific_params) do |on|
+      #       on.success { |collection|
+      #         @collection = collection
+      #         respond_with(@collection)
+      #       }
+      #     end
+      #   end
+      #
+      # @see .runner_container for customization
+      def run(*args, &block)
+        runner.run(self, *args, &block)
+      end
+
+      # A query to lookup the appropriate Runner class
+      def runner(runner_name = nil)
+        return @runner if @runner # For Dependency Injection
+        runner_name = action_name.classify unless runner_name
+        if runner_container.const_defined?(runner_name)
+          runner_container.const_get(runner_name)
+        else
+          fail RunnerNotFoundError, container: runner_container, name: runner_name
+        end
+      end
+
+      # Exposed for purposes of Dependency Injection.
+      def runner=(object)
+        fail(ImproperRunnerError, runner: object, method_name: :run) unless object.respond_to?(:run)
+        @runner = object
+      end
+
+      # Raised when a Runner is not found
+      class RunnerNotFoundError < RuntimeError # :nodoc:
+        def initialize(options = {})
+          super("Unable to find #{options.fetch(:name)} in #{options.fetch(:container)}")
+        end
+      end
+
+      # Raised when a Runner is not found
+      class ImproperRunnerError < RuntimeError # :nodoc:
+        def initialize(options = {})
+          super("Expected #{options.fetch(:runner)} to respond_to #{options.fetch(:method_name)}")
+        end
+      end
+    end
+  end
+end

data/lib/hesburgh/lib/mock_runner.rb

@@ -0,0 +1,67 @@
+module Hesburgh
+  module Lib
+    # A class to assist in circumventing the seething underlayer of potential
+    # runners and cut quick to the working with the callbacks.
+    #
+    # @example
+    #
+    #   context = []
+    #   runner = MockRunner.new(context: context, run_with: :input, yields: :yielded_value, callback_name: :success)
+    #   runner.run(:input) do |on|
+    #     on.success {|output| context << output }
+    #   end
+    #   context == [:yielded_value]
+    #   => true
+    #
+    # @see Hesrbugh::Lib::Runner
+    # @see Hesrbugh::Lib::NamedCallbacks
+    class MockRunner
+      # Raised when the actual :run_with parameter is different than the
+      # expected
+      class RunWithMismatchError < RuntimeError
+        def initialize(actual: nil, expected: nil)
+          super("RunWith Mismatch Error:\nActual: #{actual.inspect}\nExpected: #{expected.inspect}\n")
+        end
+      end
+
+      def initialize(options = {})
+        @yields = options.fetch(:yields)
+        @callback_name = options.fetch(:callback_name)
+        @run_with = __wrap__(options.fetch(:run_with))
+
+        # Because the context may automatically be getting assigned by the
+        # controller.
+        @run_with.unshift(options[:context]) if options.key?(:context)
+      end
+
+      def run(*args)
+        if @run_with == args
+          if block_given?
+            return yield(self)
+          else
+            return @callback_name, *@yields
+          end
+        else
+          fail RunWithMismatchError, actual: args, expected: @run_with
+        end
+      end
+
+      def method_missing(method_name, &_block)
+        super unless @callback_name.to_s == method_name.to_s
+        return @callback_name, *yield(@yields)
+      end
+
+      private
+
+      def __wrap__(object)
+        if object.nil?
+          []
+        elsif object.respond_to?(:to_ary)
+          object.to_ary || [object]
+        else
+          [object]
+        end
+      end
+    end
+  end
+end

data/lib/hesburgh/lib/named_callbacks.rb

@@ -0,0 +1,24 @@
+module Hesburgh
+  module Lib
+    # Responsible for registering blocks used for callbacks.
+    class NamedCallbacks
+      def initialize
+        @callbacks = {}
+      end
+
+      def method_missing(callback_name, *_args, &block)
+        @callbacks[callback_name] = block
+      end
+
+      def respond_to_missing?(callback_name)
+        @callbacks[callback_name]
+      end
+
+      def call(callback_name, *args)
+        callback_name = callback_name.to_sym
+        callback = @callbacks[callback_name]
+        callback ? callback.call(*args) : true
+      end
+    end
+  end
+end

data/lib/hesburgh/lib/runner.rb

@@ -0,0 +1,50 @@
+module Hesburgh
+  module Lib
+    # A Runner is responsible for performing the guts of what might traditionally
+    # be a controller's action.
+    #
+    # It exists for two reasons, though this is not considered exhaustive:
+    # * Controllers are extremely over-worked (parameter negotiation,
+    #   authentication, authorization, marshalling an object, user messages via
+    #   flash, and http response determination)
+    # * The inner method content of a controller's action is subject to change
+    #   especially as other implementors look to change the behavior.
+    #
+    # So, the Runner provides a seem in the code in which you can more readily
+    # make changes to the "inner method"  of a route. In some ways, I see this as
+    # a separation of state change and response; a somewhat analogous separation
+    # to the Command/Query separation principle.
+    #
+    # @see Hesrbugh::Lib::MockRunner
+    class Runner
+      def self.run(context, *args, &block)
+        new(context, &block).run(*args)
+      end
+
+      attr_reader :context
+      protected :context
+
+      def initialize(context, callbacks: nil)
+        @callbacks = callbacks || default_callbacks
+        @context = context
+        yield(@callbacks) if block_given?
+      end
+
+      def callback(name, *args)
+        @callbacks.call(name, *args)
+        return name, *args
+      end
+
+      def run(*_args)
+        fail NotImplementedError, ("You must define #{self.class}#run")
+      end
+
+      private
+
+      def default_callbacks
+        require 'hesburgh/lib/named_callbacks'
+        NamedCallbacks.new
+      end
+    end
+  end
+end

data/lib/hesburgh/lib/version.rb

@@ -0,0 +1,5 @@
+module Hesburgh
+  module Lib
+    VERSION = "0.1.0"
+  end
+end

data/lib/hesburgh/lib.rb

@@ -0,0 +1,8 @@
+require "hesburgh/lib/version"
+
+module Hesburgh
+  # The namespaced container for a toolbox of code that may be reusable.
+  module Lib
+    # Your code goes here...
+  end
+end

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: hesburgh-lib
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Friesen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-03-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !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: 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-given
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.27'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  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'
+description: A toolbox of code that may be reusable.
+email:
+- jeremy.n.friesen@gmail.com
+executables:
+- update-dependency
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/update-dependency
+- hesburgh-lib.gemspec
+- lib/hesburgh/lib.rb
+- lib/hesburgh/lib/controller_with_runner.rb
+- lib/hesburgh/lib/mock_runner.rb
+- lib/hesburgh/lib/named_callbacks.rb
+- lib/hesburgh/lib/runner.rb
+- lib/hesburgh/lib/version.rb
+homepage: https://github.com/ndlib/hesburgh-lib
+licenses:
+- APACHE2
+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.4.7
+signing_key: 
+specification_version: 4
+summary: A toolbox of code that may be reusable.
+test_files: []