spine-engines 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a68c6a541f4822ad502bd3671f04f87c714cfaed
+  data.tar.gz: d73cb5be9a66de046b4d8c9b8f9b0a76df99062e
+SHA512:
+  metadata.gz: 0969f3e6d31390ce4d2773a829f0ec0d37d5514bf1ed09459720295fc0285188dd4e96c52474b57a33bdd97ae6403375801ddffc49e14a0325a23595f05b12ca
+  data.tar.gz: 808d637219226d75925478f1b14200674372d4fea30a3867fef7b5a77ec327001bd2a7f295e58f3b3ef1a7083ed076ab897bc179d4b900849c0e00875d941ee7

data/.gitignore

@@ -0,0 +1,36 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/bin/
+/.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/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require config/default

data/CHANGELOG.md

@@ -0,0 +1,6 @@
+Changelog
+=========
+
+0.1.0
+-----
+-   First public release

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,12 @@
+Copyright (c) 2015, TOGGL LLC
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the TOGGL LLC nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,106 @@
+# Spine::Engines
+
+[![Gem Version](https://badge.fury.io/rb/spine-engines.svg)](http://badge.fury.io/rb/spine-engines)
+[![Dependency Status](https://gemnasium.com/rspine/engines.svg)](https://gemnasium.com/rspine/engines)
+[![Code Climate](https://codeclimate.com/github/rspine/engines/badges/gpa.svg)](https://codeclimate.com/github/rspine/engines)
+
+Starting point for your Rack application and its configurations.
+
+## Installation
+
+To install it, add the gem to your Gemfile:
+
+```ruby
+gem 'spine-engines'
+```
+
+Then run `bundle`. If you're not using Bundler, just `gem install spine-engines`.
+
+## Usage
+
+Define your application and configuration:
+
+```ruby
+# lib/my_app/application.rb
+
+module MyApp
+  module Application
+    extend Spine::Engines::Application
+    extend self
+
+    # Add loaders
+    loaders << Spine::Engines::Loaders::Initializers
+
+    # Add extensions
+    extension Spine::Routing::Engine
+
+    # Add your own extra configuration
+    def active_record
+      ::ActiveRecord::Base
+    end
+  end
+end
+```
+
+Define your shared configuration between environments. You can define
+environment specific configurations in `config/environments/evironment_name.rb`.
+
+```ruby
+# config/environment.rb
+
+require File.expand_path('../boot', __FILE__)
+
+environment = ENV['RACK_ENV'] || 'development'
+Bundler.require(:default, environment)
+
+require File.expand_path('../../lib/my_app/application', __FILE__)
+
+MyApp::Application.configure do |config|
+  config.environment = environment
+  config.root = File.expand_path('../..', __FILE__)
+
+  config.load_paths = %w(
+    lib/my_app/**/*.rb
+  )
+
+  # Middlewares
+  config.middleware.use Rack::Lock
+  config.middleware.use Rack::Runtime
+  config.middleware.use Rack::MethodOverride
+  config.middleware.use Rack::CommonLogger, config.logger
+  config.middleware.use Rack::Head
+  config.middleware.use Rack::ConditionalGet
+  config.middleware.use Rack::ETag
+end
+
+MyApp::Application.initialize!
+```
+
+Add Bundler to boot:
+
+```ruby
+# config/boot.rb
+
+require 'rubygems'
+
+# Set up gems listed in the Gemfile.
+gemfile = File.expand_path('../../Gemfile', __FILE__)
+begin
+  ENV['BUNDLE_GEMFILE'] = gemfile
+  require 'bundler'
+  Bundler.setup
+rescue Bundler::GemNotFound => e
+  STDERR.puts e.message
+  STDERR.puts "Try running `bundle install`."
+  exit!
+end if File.exist?(gemfile)
+```
+
+Configuring Rack to use this application:
+
+```ruby
+# config.ru
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run MyApp::Application
+```

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/spine/engines/application.rb

@@ -0,0 +1,28 @@
+module Spine
+  module Engines
+    module Application
+      include Configuration
+      include Loaders
+      include Extensions
+
+      def initialize!
+        load
+        finalize!
+      end
+
+      def call(env)
+        finalize!.call(env)
+      end
+
+      private
+
+      def finalize!
+        @finalized_app ||= builder.to_app
+      end
+
+      def load
+        loaders.each { |loader| loader.call(self) }
+      end
+    end
+  end
+end

data/lib/spine/engines/configuration.rb

@@ -0,0 +1,32 @@
+require 'pathname'
+require 'logger'
+
+module Spine
+  module Engines
+    module Configuration
+      attr_accessor :environment, :root, :load_paths
+      attr_accessor :builder, :middleware
+      attr_accessor :logger, :router
+
+      def builder
+        @builder ||= Rack::Builder.new
+      end
+
+      def middleware
+        @middleware || builder
+      end
+
+      def root=(value)
+        @root = Pathname.new(value)
+      end
+
+      def logger
+        @logger ||= Logger.new(STDOUT)
+      end
+
+      def configure
+        yield(self) if block_given?
+      end
+    end
+  end
+end

data/lib/spine/engines/extensions.rb

@@ -0,0 +1,17 @@
+module Spine
+  module Engines
+    module Extensions
+      def extension(plugin)
+        if plugin.respond_to?(:configuration) && plugin.configuration
+          self.extend(plugin.configuration)
+        end
+
+        if plugin.respond_to?(:loader) && plugin.loader
+          self.loaders << plugin.loader
+        end
+
+        self
+      end
+    end
+  end
+end

data/lib/spine/engines/loaders/default.rb

@@ -0,0 +1,19 @@
+module Spine
+  module Engines
+    module Loaders
+      module Default
+        def loaders
+          @loaders ||= default_loaders
+        end
+
+        def loaders=(value)
+          @loaders = value
+        end
+
+        def default_loaders
+          [LoadPaths, EnvironmentConfiguration]
+        end
+      end
+    end
+  end
+end

data/lib/spine/engines/loaders/environment_configuration.rb

@@ -0,0 +1,13 @@
+module Spine
+  module Engines
+    module Loaders
+      module EnvironmentConfiguration
+        extend self
+
+        def call(app)
+          require app.root.join('config', 'environments', app.environment).to_s
+        end
+      end
+    end
+  end
+end

data/lib/spine/engines/loaders/initializers.rb

@@ -0,0 +1,14 @@
+module Spine
+  module Engines
+    module Loaders
+      module Initializers
+        extend self
+
+        def call(app)
+          source = app.root.join('config', 'initializers', '*.rb')
+          Dir[source].each { |file| require file }
+        end
+      end
+    end
+  end
+end

data/lib/spine/engines/loaders/load_paths.rb

@@ -0,0 +1,15 @@
+module Spine
+  module Engines
+    module Loaders
+      module LoadPaths
+        extend self
+
+        def call(app)
+          app.load_paths.each do |path|
+            Dir[app.root.join(path)].each { |file| require file }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/spine/engines/loaders.rb

@@ -0,0 +1,12 @@
+module Spine
+  module Engines
+    module Loaders
+      autoload :Default, 'spine/engines/loaders/default'
+      autoload :EnvironmentConfiguration, 'spine/engines/loaders/environment_configuration'
+      autoload :Initializers, 'spine/engines/loaders/initializers'
+      autoload :LoadPaths, 'spine/engines/loaders/load_paths'
+
+      include Default
+    end
+  end
+end

data/lib/spine/engines/version.rb

@@ -0,0 +1,5 @@
+module Spine
+  module Engines
+    VERSION = '0.1.0'
+  end
+end

data/lib/spine/engines.rb

@@ -0,0 +1,8 @@
+module Spine
+  module Engines
+    autoload :Application, 'spine/engines/application'
+    autoload :Configuration, 'spine/engines/configuration'
+    autoload :Loaders, 'spine/engines/loaders'
+    autoload :Extensions, 'spine/engines/extensions'
+  end
+end

data/spine-engines.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'spine/engines/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "spine-engines"
+  spec.version       = Spine::Engines::VERSION
+  spec.authors       = ["TOGGL LLC"]
+  spec.email         = ["support@toggl.com"]
+  spec.summary       = ''
+  spec.description   = ''
+  spec.homepage      = 'https://github.com/rspine/engines'
+  spec.license       = 'BSD-3-Clause'
+
+  spec.files         = `git ls-files -z`.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_dependency 'rack', '~> 1.6'
+
+  spec.add_development_dependency 'bundler', '~> 1.7'
+  spec.add_development_dependency 'rake', '~> 10.0'
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: spine-engines
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- TOGGL LLC
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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'
+description: ''
+email:
+- support@toggl.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/spine/engines.rb
+- lib/spine/engines/application.rb
+- lib/spine/engines/configuration.rb
+- lib/spine/engines/extensions.rb
+- lib/spine/engines/loaders.rb
+- lib/spine/engines/loaders/default.rb
+- lib/spine/engines/loaders/environment_configuration.rb
+- lib/spine/engines/loaders/initializers.rb
+- lib/spine/engines/loaders/load_paths.rb
+- lib/spine/engines/version.rb
+- spine-engines.gemspec
+homepage: https://github.com/rspine/engines
+licenses:
+- BSD-3-Clause
+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.5
+signing_key: 
+specification_version: 4
+summary: ''
+test_files: []