sinatra-drumkit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 626e0995f180d3eb78414b6c261dbfc107620dc2
+  data.tar.gz: 4fd4d5ac512194a576f3cf57b2ba59d8a5515600
+SHA512:
+  metadata.gz: a87388a29538d03bccf44bcc7bf5f6f5eff5cca09357acb8f0ac658a93db1d1d2481e9cab2cac918b236506d5d373abeeb9f520c4d8df13fae0a1313a080f4ea
+  data.tar.gz: 1a977b4dd551f55e3f9cf96e157dd5bb1486b3a2e683b3894612ee9588554d7f6cac41eb8465f70a9602af2dcb1ed685639bb5e63695ad2dedabd99889f29eeb

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at contact@zell.io. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Zachary Elliott <contact@zell.io>
+
+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,83 @@
+# Sinatra::Drumkit
+
+A simple framework for auto loading model and controller code in sinatra apps.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sinatra-drumkit'
+```
+
+And then execute:
+
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install sinatra-drumkit
+```
+
+## Usage
+
+`Sinatra::Drumkit` provides simple auto-loading mechanisms to `sinatra`. Once
+the `module` is registered, one can configure it via the `rhythm`
+method. `Drumkit` will make a best guess based on the `root` setting of the
+application.
+
+```ruby
+class App < Sinatra::Base
+  set :root, -> { File.expand_path(__dir__) }
+
+  register Sinatra::Drumkit
+  rhythm namespace: App
+
+  # Models are now auto-loaded into App::Model...
+  # Controllers have been executed in the context of the current app
+end
+```
+
+Generally it search `PROJECT_ROOT/app/models` for model code and
+`PROJECT_ROOT/app/controllers` for controller code.
+
+One will need to set the parent name space for Models which will subsequently
+be loaded into the `Namespace::Model` module.
+
+Controllers are loaded and executed in the context of the application so they
+can be written as though they were in the body of the `siantra` app.
+
+```ruby
+# file: ./app/controllers/index.rb
+
+get /
+  [200, {}, 'Hello world!']
+end
+```
+
+## Development
+
+After checking out the repo, run `bundle update` to install
+dependencies. Then, run `rake spec` to run the tests.
+
+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]/sinatra-drumkit. 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/lib/sinatra/drumkit/version.rb

@@ -0,0 +1,5 @@
+module Sinatra
+  module Drumkit
+    VERSION = '0.1.0'.freeze
+  end
+end

data/lib/sinatra/drumkit.rb

@@ -0,0 +1,44 @@
+require 'sinatra/base'
+
+#
+module Sinatra
+  #
+  module Drumkit
+    def rhythm(app_dir: nil, model_dir: nil, controller_dir: nil,
+               namespace: Sinatra::Drumkit)
+
+      app_dir ||= File.join(root, 'app')
+      model_dir ||= File.join(app_dir, 'models')
+      controller_dir ||= File.join(app_dir, 'controllers')
+
+      model_module = model_autoloader(model_dir)
+      namespace.const_set(:Model, model_module)
+
+      load_controllers(controller_dir)
+    end
+
+    private
+
+    def model_autoloader(load_dir)
+      Module.new do
+        define_singleton_method(
+          :const_missing, lambda { |const|
+            @searched ||= {}
+            raise "Class not found: #{const}" if @searched[const]
+            require File.join(load_dir, "#{const.to_s.downcase}.rb")
+            @searched[const] = true
+            const_get(const) || raise("Class not found: #{const}")
+          }
+        )
+      end
+    end
+
+    def load_controllers(load_dir)
+      Dir[::File.join(load_dir, '*.rb')].each do |file|
+        instance_eval(File.read(file), file)
+      end
+    end
+  end
+
+  register Drumkit
+end

data/sinatra-drumkit.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sinatra/drumkit/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'sinatra-drumkit'
+  spec.version = Sinatra::Drumkit::VERSION
+  spec.authors = ['Zachary Elliott']
+  spec.email = ['contact@zell.io']
+
+  spec.summary = 'Provide clean MVC autoloading for sinatra'
+  spec.description = "Provide autoloading of Model classes and Controller for
+  sinatra to allow for simpler writing of MVC web applications."
+
+  spec.homepage = 'https://github.com/zellio/sinatra-drumkit'
+  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_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+
+  spec.add_dependency 'sinatra', '~> 1.4'
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: sinatra-drumkit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Zachary Elliott
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+description: |-
+  Provide autoloading of Model classes and Controller for
+    sinatra to allow for simpler writing of MVC web applications.
+email:
+- contact@zell.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sinatra/drumkit.rb
+- lib/sinatra/drumkit/version.rb
+- sinatra-drumkit.gemspec
+homepage: https://github.com/zellio/sinatra-drumkit
+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: Provide clean MVC autoloading for sinatra
+test_files: []