sat 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d61541e8ff5d1b9e7e73663114e0e191a6538176
+  data.tar.gz: 371a0d94add8edff5e0a7960e2a4579ae078b973
+SHA512:
+  metadata.gz: 316d398b58aa9a1e98c88cfe16f7f19bf279987832b51b284ecf671d175e9ee1a017b1300ffd3ef3d553ac2ec7b9c4602c19d60a5707bd3b0c37f281d534f0f9
+  data.tar.gz: 47cc9a162000c3d4d820c28797594b2fd4c353321f977ab0145c32c523dacff73cc4994bd5478b5b0083b4481de958ffe84b2151da0debab24bf85149903a5fe

data/.gitignore

@@ -0,0 +1,2 @@
+Gemfile.lock
+log/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Fernando Martinez
+
+MIT License
+
+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,176 @@
+# SAT
+
+[Sinatra](https://github.com/sinatra/sinatra) Application Template.
+
+## Features
+
+* Sinatra modular application. Inspired by [travis-admin](https://github.com/travis-ci/travis-admin).
+* Per-environment configuration in separated files.
+* Separate routes in controllers.
+* Separated directories for controllers' views.
+* Per-controller helpers.
+* Initializers support.
+* [sinatra-contrib](https://github.com/sinatra/sinatra)
+* [sinatra-partial](https://github.com/yb66/Sinatra-Partial)
+* [i18n](https://github.com/svenfuchs/i18n).
+* [minitest](https://github.com/seattlerb/minitest).
+* [rack-test](https://github.com/brynary/rack-test).
+* [slim](https://github.com/slim-template/slim).
+* [sprockets](https://github.com/sstephenson/sprockets).
+* [thin](https://github.com/macournoyer/thin).
+
+## Install
+
+For generating new projects with  SAT you can use ```sat gem``` or do a manual install.
+
+### Using the sat gem
+
+Simply run:
+
+```bash
+$ gem install sat
+$ sat <new_app_name>
+```
+
+Available options are:
+
+* **--template <git_url>**: clone template from the specified repository.
+* **--git <git_url>**: if specified, a new git repository will be setup for your project with its origin set to __<git_url>__.
+* **--no-bundler**: switch to disable calling __bundle install__ after cloning the template.
+
+
+### Manual install
+
+* Clone the repository:
+
+```bash
+$ git clone git@github.com:patriciomacadden/sat.git
+```
+
+* Create a git repository and change the `origin`:
+
+```bash
+$ git remote rm origin
+$ git remote add origin <YOUR_GIT_REPOSITORY>
+```
+
+* Change the application name (and commit the change):
+
+```bash
+$ APP_NAME=AwesomeApp; for i in `find . -type f | grep -v .git`; do if [ `grep SAT $i | wc -l` != 0 ]; then sed -i '' "s/SAT/$APP_NAME/g" $i; fi; done; git commit -am "SAT => $APP_NAME"
+```
+
+**Note**: Note the `APP_NAME` variable. You should change the application name
+there.
+
+## Creating a new controller
+
+Let's create a controller for handling products.
+
+* Create `app/controlers/products_controller.rb`
+
+```ruby
+module SAT::Application
+  class ProductsController < ApplicationController
+    set prefix: '/products'
+    # views will be found in app/views/products directory.
+    # If you want to change the views directory, use this
+    # configuration option.
+    # set views_prefix: '/some_other_directory'
+
+    get '/' do
+      # will render app/views/products/index.slim
+      # slim :index
+      'Hello World'
+    end
+  end
+end
+```
+
+* Create `app/helpers/products_helpers.rb`
+
+```ruby
+module SAT::Application
+  module ProductsHelpers
+    # helper methods
+  end
+end
+```
+
+* Create the views directory
+
+```bash
+$ mkdir app/views/products
+```
+
+* Create `spec/controllers/products_controller_spec.rb`
+
+```ruby
+require 'minitest_helper'
+
+describe SAT::Application::ProductsController do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+
+  describe 'GET /products' do
+    it 'must be ok' do
+      get '/products'
+      last_response.must_be :ok?
+    end
+  end
+end
+```
+
+* Create `spec/helpers/products_helpers_spec.rb`
+
+```ruby
+require 'minitest_helper'
+
+describe SAT::Application::ProductsHelpers do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+end
+```
+
+## Custom settings
+
+Two settings are introduced:
+
+* `prefix`: It indicates where to map a controller. **Must** be used in every
+controller.
+* `views_prefix`: It indicates where to find the views. If not set, `prefix` is
+used to find the views.
+
+## Caveats
+
+Since the application itself its a `Rack::Builder` that maps the different
+controllers to a particular path, you need to use that builder to use any rack
+middleware.
+
+See an example:
+
+```ruby
+# in environment.rb:
+
+config.builder.use Rack::Auth::Basic do |username, password|
+  username == 'admin' && password == 'secret'
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See the [LICENSE](https://github.com/patriciomacadden/sat/blob/master/LICENSE).

data/Rakefile

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

data/bin/sat

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/sat/version'
+require 'trollop'
+require 'pathname'
+require 'tmpdir'
+
+class App
+  @@version = "SAT Command Line Interface " << Sat::VERSION
+  @@usage = <<-EOS
+Command line interface for the Sinatra Application Template
+
+Usage:
+       sat [options] <app_name>
+
+options:
+EOS
+
+  def initialize(args)
+    parse_options!
+    @name = args.first
+    validate!
+    @name = @name.downcase
+  end
+
+  def run
+    clone_template
+    rename
+    git_setup if @options[:git]
+    install_bundle unless @options[:no_bundler]
+
+    puts "Done! your new app is in #{@name.downcase}"
+  end
+
+  private
+  def parse_options!
+    @options = Trollop::options do
+      version @@version
+      banner @@usage
+
+      opt :git,        'Git reposotory where new app will be versioned.', type: String
+      opt :template,   'Git repository url of template to use.', default: 'https://github.com/patriciomacadden/sat'
+      opt :no_bundler,  "If specified, after processing template 'bundle install' won't be run"
+    end
+  end
+
+  def validate!
+    if @name.nil? || @name.empty?
+      Trollop::die "You must specify the new application name"
+    end
+  end
+
+  def clone_template
+    tmp = Pathname.new(Dir.tmpdir).join @name
+    exec "Aquiring template application from: #{@options[:template]}", "git clone #{@options[:template]} #{tmp}"
+    exec "Deploying template..." do
+      FileUtils.mv(tmp.join('template'), @name)
+      FileUtils.cd(@name)
+    end
+  end
+
+  def rename
+    exec("renaming project...") do
+      all_files.each {|path| replace_name(path, camelize(@name)) }
+    end
+  end
+
+  def git_setup
+    exec('Initializing Git...', 'git init')
+    exec("Git origin set to #{@options[:git]}", "git remote add origin #{@options[:git]}")
+  end
+
+  def install_bundle
+    exec('installing your gem bundle...', 'bundle install')
+  end
+
+  def exec(message, task = nil, &block)
+    puts message
+      `#{task}` if task
+      block.call if block_given?
+  end
+
+  def replace_name(path, name)
+    contents = File.read(path)
+    template = 'SAT'
+    File.write(path, File.read(path).gsub(template, name)) if contents.include? template
+  end
+
+  def all_files
+    Dir.glob('**/*').reject {|file| Dir.exists? file }
+  end
+
+  def camelize(str)
+    str.split('_').collect{ |s| s.capitalize! }.join
+  end
+end
+
+App.new(ARGV).run

data/lib/sat.rb

@@ -0,0 +1,5 @@
+require "sat/version"
+
+module Sat
+  # Your code goes here...
+end

data/lib/sat/version.rb

@@ -0,0 +1,3 @@
+module Sat
+  VERSION = "0.0.1"
+end

data/sat.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sat/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "sat"
+  spec.version       = Sat::VERSION
+  spec.authors       = ["Patricio Mac Adden", "Fernando Martínez"]
+  spec.email         = ["patriciomacadden@gmail.com"]
+  spec.description   = "Sinatra Application Template"
+  spec.summary       = "A sinatra application boilerplate"
+  spec.homepage      = "https://github.com/patriciomacadden/sat"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = ['sat']
+  spec.test_files    = []
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'trollop', '~> 2.0'
+end

data/template/Gemfile

@@ -0,0 +1,22 @@
+source 'https://rubygems.org'
+
+gem 'i18n'
+gem 'sinatra', require: 'sinatra/base'
+# or use master:
+# gem 'sinatra', github: 'sinatra/sinatra', require: 'sinatra/base'
+gem 'sinatra-contrib'
+# or use master:
+# gem 'sinatra-contrib', github: 'sinatra/sinatra-contrib'
+gem 'sinatra-partial'
+gem 'slim'
+gem 'sprockets'
+gem 'thin'
+
+group :development, :test do
+  gem 'rake'
+end
+
+group :test do
+  gem 'minitest', require: 'minitest/autorun'
+  gem 'rack-test', require: 'rack/test'
+end

data/template/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Patricio Mac Adden
+
+MIT License
+
+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/template/README.md

@@ -0,0 +1,21 @@
+# SAT
+
+ TODO:  Project description
+
+## Features
+
+## Install
+
+## Usage
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+
+See the [LICENSE](LICENSE).

data/template/Rakefile

@@ -0,0 +1,9 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+desc 'Run tests'
+task default: :test

data/template/app/assets/javascripts/application.js

@@ -0,0 +1,2 @@
+//= require_tree .
+//= require_self

data/template/app/assets/stylesheets/application.css

@@ -0,0 +1,4 @@
+/**
+ *= require_tree .
+ *= require_self
+ */

data/template/app/controllers/application_controller.rb

@@ -0,0 +1,34 @@
+module SAT::Application
+  class ApplicationController < Sinatra::Base
+    set builder: Rack::Builder.new
+    set controllers: []
+
+    helpers SAT::Application::ApplicationHelpers
+
+    def self.inherited(subclass)
+      controllers << subclass unless controllers.include? subclass
+      subclass.set :app_file, caller_files.detect { |f| f != app_file }
+      super
+    end
+
+    def self.new(*)
+      self == ApplicationController ? builder.to_app : super
+    end
+
+    def self.prefix=(value)
+      controller = self
+      define_singleton_method(:prefix) { value }
+      builder.map(value) { run controller }
+    end
+
+    def self.views_prefix=(value)
+      define_singleton_method(:views_prefix) { value }
+    end
+
+    def find_template(views, name, engine, &block)
+      super(File.join(views, settings.views_prefix), name, engine, &block) if settings.respond_to? :views_prefix
+      super(File.join(views, settings.prefix), name, engine, &block) if settings.respond_to? :prefix
+      super(File.join(views, 'application'), name, engine, &block)
+    end
+  end
+end

data/template/app/controllers/root_controller.rb

@@ -0,0 +1,12 @@
+module SAT::Application
+  class RootController < ApplicationController
+    set prefix: '/'
+    set views_prefix: '/root'
+
+    helpers SAT::Application::RootHelpers
+
+    get '/' do
+      slim :index
+    end
+  end
+end

data/template/app/helpers/application_helpers.rb

@@ -0,0 +1,4 @@
+module SAT::Application
+  module ApplicationHelpers
+  end
+end

data/template/app/helpers/root_helpers.rb

@@ -0,0 +1,4 @@
+module SAT::Application
+  module RootHelpers
+  end
+end

data/template/app/views/layouts/application.slim

@@ -0,0 +1,8 @@
+doctype html
+html
+  head
+    title SAT
+    script src="/javascripts/application.js" type="text/javascript"
+    == stylesheet '/stylesheets/application.css'
+  body
+    == yield

data/template/app/views/root/index.slim

@@ -0,0 +1 @@
+h1 = I18n.t 'views.root.index.title'

data/template/config.ru

@@ -0,0 +1,3 @@
+require File.expand_path(File.join('config', 'application'))
+
+run SAT::Application

data/template/config/application.rb

@@ -0,0 +1,26 @@
+require 'bundler'
+require 'forwardable'
+
+Bundler.require :default, ENV['RACK_ENV']
+
+module SAT
+  module Application
+    # require the application helpers
+    require File.expand_path(File.join('app', 'helpers', 'application_helpers'))
+    # require the application controller
+    require File.expand_path(File.join('app', 'controllers', 'application_controller'))
+
+    extend SingleForwardable
+    def_single_delegators ApplicationController, :call, :configure, :new, :settings
+
+    require File.expand_path(File.join('config', 'environment'))
+    Dir[File.join('config', 'environments', '**/*.rb')].each { |file| require File.expand_path(file) }
+
+    # require the application's initializers
+    Dir[File.join('config', 'initializer', '**/*.rb')].each { |file| require File.expand_path(file) }
+    # require the rest of the helpers
+    Dir[File.join('app', 'helpers', '**/*.rb')].each { |file| require File.expand_path(file) }
+    # require the rest of the controllers
+    Dir[File.join('app', 'controllers', '**/*.rb')].each { |file| require File.expand_path(file) }
+  end
+end

data/template/config/environment.rb

@@ -0,0 +1,42 @@
+SAT::Application.configure do |config|
+  # directory structure
+  config.set :root, File.expand_path('../..', __FILE__)
+  config.set :views, File.join(config.root, 'app', 'views')
+
+  # i18n
+  I18n.load_path = Dir[File.join('config', 'locales', '*.{rb,yml}').to_s]
+  I18n.default_locale = 'en'
+
+  # link header
+  config.helpers Sinatra::LinkHeader
+
+  # logging
+  file = File.new("#{config.root}/log/#{config.environment}.log", 'a+')
+  file.sync = true
+  config.use Rack::CommonLogger, file
+
+  # method override
+  config.enable :method_override
+
+  # partial
+  config.register Sinatra::Partial
+  config.set :partial_template_engine, :slim
+  config.enable :partial_underscores
+
+  # sessions
+  config.enable :sessions
+
+  # show exceptions
+  config.enable :show_exceptions
+
+  # sprockets
+  config.builder.map '/assets' do
+    environment = Sprockets::Environment.new
+    environment.append_path File.join(config.root, 'app', 'assets', 'javascripts')
+    environment.append_path File.join(config.root, 'app', 'assets', 'stylesheets')
+    run environment
+  end
+
+  # template engine
+  config.set :slim, layout_engine: :slim, layout: '../layouts/application'.to_sym
+end

data/template/config/environments/development.rb

@@ -0,0 +1,3 @@
+SAT::Application.configure :development do |config|
+  config.register Sinatra::Reloader
+end

data/template/config/environments/production.rb

@@ -0,0 +1,2 @@
+SAT::Application.configure :production do |config|
+end

data/template/config/environments/test.rb

@@ -0,0 +1,2 @@
+SAT::Application.configure :test do |config|
+end

data/template/config/locales/en.yml

@@ -0,0 +1,5 @@
+en:
+  views:
+    root:
+      index:
+        title: Hello World

data/template/spec/controllers/application_controller_spec.rb

@@ -0,0 +1,9 @@
+require 'minitest_helper'
+
+describe SAT::Application::ApplicationController do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+end

data/template/spec/controllers/root_controller_spec.rb

@@ -0,0 +1,17 @@
+require 'minitest_helper'
+
+describe SAT::Application::RootController do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+
+  describe 'GET /' do
+    it 'must be ok' do
+      get '/'
+      last_response.must_be :ok?
+      last_response.body.must_match 'Hello World'
+    end
+  end
+end

data/template/spec/helpers/application_helpers_spec.rb

@@ -0,0 +1,9 @@
+require 'minitest_helper'
+
+describe SAT::Application::ApplicationHelpers do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+end

data/template/spec/helpers/root_helpers_spec.rb

@@ -0,0 +1,9 @@
+require 'minitest_helper'
+
+describe SAT::Application::RootHelpers do
+  include Rack::Test::Methods
+
+  def app
+    SAT::Application
+  end
+end

data/template/spec/minitest_helper.rb

@@ -0,0 +1,3 @@
+ENV['RACK_ENV'] = 'test'
+
+require File.expand_path(File.join('config', 'application'))

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: sat
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patricio Mac Adden
+- Fernando Martínez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: trollop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Sinatra Application Template
+email:
+- patriciomacadden@gmail.com
+executables:
+- sat
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/sat
+- lib/sat.rb
+- lib/sat/version.rb
+- sat.gemspec
+- template/Gemfile
+- template/LICENSE
+- template/README.md
+- template/Rakefile
+- template/app/assets/images/.gitkeep
+- template/app/assets/javascripts/application.js
+- template/app/assets/stylesheets/application.css
+- template/app/controllers/application_controller.rb
+- template/app/controllers/root_controller.rb
+- template/app/helpers/application_helpers.rb
+- template/app/helpers/root_helpers.rb
+- template/app/models/.gitkeep
+- template/app/views/layouts/application.slim
+- template/app/views/root/index.slim
+- template/config.ru
+- template/config/application.rb
+- template/config/environment.rb
+- template/config/environments/development.rb
+- template/config/environments/production.rb
+- template/config/environments/test.rb
+- template/config/initializers/.gitkeep
+- template/config/locales/en.yml
+- template/log/.gitkeep
+- template/spec/controllers/application_controller_spec.rb
+- template/spec/controllers/root_controller_spec.rb
+- template/spec/helpers/application_helpers_spec.rb
+- template/spec/helpers/root_helpers_spec.rb
+- template/spec/minitest_helper.rb
+- template/spec/models/.gitkeep
+homepage: https://github.com/patriciomacadden/sat
+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.0.3
+signing_key: 
+specification_version: 4
+summary: A sinatra application boilerplate
+test_files: []