sinator 3.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2b43b8566572040b2ff40282859004442ee2a439
+  data.tar.gz: 0b52f96d8ef24cd192757a9cf98fcecff1f91eb3
+SHA512:
+  metadata.gz: 94b3958e6ff48c01b96a77642f22ea61aa43b9de9e9a34d86944fb57db3dba0f692d03a6f4763e9f91ed9a9e505d5bd3e8192f757caaedda6e8daf8e813cde6d
+  data.tar.gz: 4d196b9afe648b1a2db1d7767f720e0e35a91717f08d0ed3dfda8aafbe612821a0ccf30210d1409c724871b747bdc422f9651f5144aff2580fa5814c144c5bef

data/.gitignore

@@ -0,0 +1,5 @@
+*~
+*.swp
+*.swo
+*.gem
+.DS_Store

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/CHANGELOG.md

@@ -0,0 +1,46 @@
+3.0.0:
+  * set explicit version to all required ruby gems
+  * replace sinatra-asset-pipeline with sprockets
+  * generate database.yml instead of database.yml.example
+  * add rake tasks to perform assets:precompile and assets:clean
+  * replace Thin web server with Puma web server
+  * rename project to Sinator
+
+2.0.1:
+  * prevent sinatra-contrib to be required on Gemfile. Sinatra contrib is interfering with Rake’s own namespace support
+
+2.0.0:
+  * remove Melodiest::Application, only focus on application boilerplate
+
+1.0.0:
+  * prevent tux to be required
+  * add sinatra assets pipeline extension
+  * restructure generated app
+  * use erb for app templates
+  * create Rakefile generator with and without database
+  * add new Sequel configuration when generating app with database
+  * add Sinatra::Cache extension
+  * remove Melodiest::Setting. Rename setup method to cookie_secret.
+  * restructure generated app
+  * add some configurations from h5bp
+
+0.4.0:
+  * add SQL logger to development environment
+  * generate public dir when running generator
+  * use tux as Sinatra console
+  * when has no option, melodiest command will use --help option
+
+0.3.0:
+  * remove Melodiest::Auth::Http module, it's better to use sinatra-authorization extension
+  * refactor Melodiest::Setting.setup so that it can be overridden via app and remove thin as dependency
+  * add generator for sequel orm and postgres sql
+  * use encrypted cookie
+  * add generator for Rack::Csrf
+
+0.2.x:
+  * add sinatra application boilerplate generator
+  * add melodiest command to run generator
+
+0.1.x:
+ * add http authorization module
+ * set thin as server

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    sinator (2.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    rspec (3.2.0)
+      rspec-core (~> 3.2.0)
+      rspec-expectations (~> 3.2.0)
+      rspec-mocks (~> 3.2.0)
+    rspec-core (3.2.3)
+      rspec-support (~> 3.2.0)
+    rspec-expectations (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-mocks (3.2.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.2.0)
+    rspec-support (3.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  sinator!
+  rspec (= 3.2.0)
+
+BUNDLED WITH
+   1.15.3

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015-2016 Kunto Aji Kristianto
+
+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,126 @@
+# Background
+
+Sinator is [Sinatra](http://www.sinatrarb.com/) application boilerplate. It provides generator and contains minimum configuration to develop web application with Sinatra.
+The reasons behind this project because I want to create many small web application based on sinatra with other third party ruby gems as foundation.
+
+# Features
+* Generate Sinatra based web application without database
+* Generate Sinatra based web application with PostgreSQL database configuration and Sequel as ORM
+
+### Installation
+
+```ruby
+gem install sinator
+```
+
+with Bundler, put this code in your Gemfile:
+
+```ruby
+gem 'sinator'
+```
+
+### How to Use
+generate app in current directory without database
+
+```
+sinator -n my_app
+```
+
+generate app in target directory without database
+
+```
+sinator -n my_app -t target/dir
+```
+
+generate app in current directory with database. `-d` option will generate app with `Sequel` ORM and PostgreSQL adapter.
+
+```
+sinator -n my_app -d
+```
+
+### Example Usage
+This example assume that PostgreSQL is already running and desired database is already exist.
+For complete example see [github.com/kuntoaji/todo_sinator](https://github.com/kuntoaji/todo_sinator)
+  1. run `sinator -n my_app -d`
+  2. cd `my_app`
+  3. run `bundle install`
+  4. configure your database setting in `config/database.yml`
+  5. create file `db/migrations/001_create_artists.rb` and put the following code:
+
+  ```ruby
+  Sequel.migration do
+    up do
+      create_table(:artists) do
+        primary_key :id
+        String :name, :null=>false
+      end
+    end
+
+    down do
+      drop_table(:artists)
+    end
+  end
+  ```
+
+  6. run `rake db:migrate`
+  7. create file `app/models/Artist.rb` and put the following code:
+
+  ```ruby
+  class Artist < Sequel::Model
+  end
+  ```
+
+  8. create file `app/routes/artists.rb` and put the following code:
+
+  ```ruby
+  class MyApp
+    get '/artists' do
+      @artists = Artist.all
+      erb :"artists/index"
+    end
+
+    post '/artists' do
+      @artist = Artist.new
+      @artist.name = params[:name]
+      @artist.save
+
+      redirect '/artists'
+    end
+  end
+  ```
+
+  9. create file `app/views/artists/index.erb` and put the following code:
+
+  ```erb
+  <h1>List of Artist</h1>
+  <ul>
+    <% @artists.each do |artist| %>
+      <li><%= artist.name %></li>
+    <% end %>
+  </ul>
+
+  <form action="/artists" method="post">
+    <%= Rack::Csrf.tag(env) %>
+    <input type="text" name="name" />
+    <button>Submit</button>
+  </form>
+  ```
+
+  10. run the server `bundle exec puma`
+  11. open url `localhost:3000/artists`
+
+### List of Ruby Gems
+
+  * sinatra
+  * sinatra-contrib
+  * encrypted_cookie
+  * `Sinatra::Reloader` in development environment only
+  * puma
+  * `Rack::Session::EncryptedCookie`
+  * `Rack::Csrf`
+  * sequel
+  * sequel_pg as PostgreSQL adapter
+  * sprockets
+  * sass
+  * uglifier
+  * tux for console

data/bin/sinator

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/sinator/command'
+
+puts Sinator::Command.parse ARGV

data/lib/sinator/command.rb

@@ -0,0 +1,61 @@
+require 'optparse'
+require_relative 'generator'
+
+module Sinator
+
+  class Command
+    def self.parse(options)
+      options = %w(--help) if options.empty? || options.nil?
+      args = {}
+      result = nil
+
+      option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: sinator [options]"
+
+        opts.on("-h", "--help", "Print this help") do
+          result = opts.to_s
+        end
+
+        opts.on("-v", "--version", "Show version") do
+          result = Sinator::VERSION
+        end
+
+        opts.on("-nNAME", "--name=NAME", "generate app with name from this option") do |name|
+          args[:name] = name
+        end
+
+        opts.on("-tDIR", "--target=DIR", "instead of current directory, generate app in target DIR") do |target|
+          args[:target] = target
+        end
+
+        opts.on("-d", "--database", "add sequel orm for postgres sql") do
+          args[:database] = true
+        end
+
+      end
+
+      option_parser.parse! options
+
+      result = run(args) unless args[:name].nil?
+
+      result
+    end
+
+    def self.run(args)
+      generator = Sinator::Generator.new args[:name],
+        destination: args[:target], with_database: args[:database]
+
+      generator.generate_app
+      generator.generate_rakefile
+      generator.generate_gemfile
+      generator.generate_bundle_config
+      generator.generate_puma_config
+
+      msg = "#{args[:name]} is successfully generated"
+      msg << " in #{args[:target]}" if args[:target]
+
+      msg
+    end
+  end
+
+end

data/lib/sinator/generator.rb

@@ -0,0 +1,106 @@
+require 'fileutils'
+require 'securerandom'
+require 'erb'
+require_relative 'version'
+
+module Sinator
+
+  class Generator
+    attr_accessor :destination, :app_name, :app_class_name
+
+    def initialize(app_name, options={})
+      @app_name = app_name
+      @app_class_name = app_name.split("_").map{|s| s.capitalize }.join("")
+
+      destination = options[:destination] ? "#{options[:destination]}/#{@app_name}" : @app_name
+      @with_database = options[:with_database]
+
+      unless File.directory?(destination)
+        FileUtils.mkdir_p(destination)
+      end
+
+      @destination = File.expand_path(destination)
+    end
+
+    def generate_rakefile
+      gemfile = File.read File.expand_path("../templates/Rakefile.erb", __FILE__)
+      erb = ERB.new gemfile, 0, '-'
+
+      File.open "#{@destination}/Rakefile", "w" do |f|
+        f.write erb.result(binding)
+      end
+    end
+
+    def generate_gemfile
+      gemfile = File.read File.expand_path("../templates/Gemfile.erb", __FILE__)
+      erb = ERB.new gemfile, 0, '-'
+
+      File.open "#{@destination}/Gemfile", "w" do |f|
+        f.write erb.result(binding)
+      end
+    end
+
+    def generate_bundle_config
+      config_ru = File.read File.expand_path("../templates/config.ru.erb", __FILE__)
+      erb = ERB.new config_ru
+
+      File.open "#{@destination}/config.ru", "w" do |f|
+        f.write erb.result(binding)
+      end
+    end
+
+    def generate_puma_config
+      puma_development = File.read File.expand_path("../templates/config/puma/development.erb", __FILE__)
+      puma_production = File.read File.expand_path("../templates/config/puma/production.erb", __FILE__)
+
+      erb = ERB.new puma_development, 0, '-'
+      File.open "#{@destination}/config/puma/development.rb", "w" do |f|
+        f.write erb.result(binding)
+      end
+
+      erb = ERB.new puma_production, 0, '-'
+      File.open "#{@destination}/config/puma/production.rb", "w" do |f|
+        f.write erb.result(binding)
+      end
+    end
+
+    # https://github.com/sinatra/sinatra-book/blob/master/book/Organizing_your_application.markdown
+    def generate_app
+      copy_templates
+      app = File.read File.expand_path("../templates/app.erb", __FILE__)
+      erb = ERB.new app, 0, '-'
+
+      File.open "#{@destination}/#{@app_name}.rb", "w" do |f|
+        f.write erb.result(binding)
+      end
+
+      route = File.read File.expand_path("../templates/app/routes/home.erb", __FILE__)
+      erb = ERB.new route, 0, '-'
+
+      File.open "#{@destination}/app/routes/home.rb", "w" do |f|
+        f.write erb.result(binding)
+      end
+
+      FileUtils.rm "#{@destination}/app/routes/home.erb"
+    end
+
+    private
+
+    def copy_templates
+      FileUtils.cp_r File.expand_path("../templates/assets", __FILE__), @destination
+      FileUtils.cp_r File.expand_path("../templates/config", __FILE__), @destination
+      FileUtils.cp_r File.expand_path("../templates/public", __FILE__), @destination
+      FileUtils.cp_r File.expand_path("../templates/app", __FILE__), @destination
+      FileUtils.rm "#{@destination}/config/puma/development.erb"
+      FileUtils.rm "#{@destination}/config/puma/production.erb"
+
+      if @with_database
+        FileUtils.mkdir "#{@destination}/app/models"
+        FileUtils.cp_r File.expand_path("../templates/db", __FILE__), @destination
+      else
+        FileUtils.rm "#{@destination}/config/database.yml"
+      end
+    end
+  end
+
+end

data/lib/sinator/templates/Gemfile.erb

@@ -0,0 +1,15 @@
+source 'https://rubygems.org'
+
+gem 'sinatra', '2.0.0'
+gem 'sinatra-contrib', '2.0.0', require: false
+gem 'encrypted_cookie', '0.0.5'
+gem 'rack_csrf', '2.6.0', require: 'rack/csrf'
+gem 'puma', '3.11.0'
+gem 'tux', '0.3.0', require: false
+gem 'uglifier', '4.1.3', require: false
+gem 'sass', '3.5.5', require: false
+gem 'sprockets', '3.7.1'
+<% if @with_database -%>
+gem 'sequel', '5.4.0'
+gem 'sequel_pg', '1.8.1', require: 'sequel'
+<% end -%>

data/lib/sinator/templates/Rakefile.erb

@@ -0,0 +1,33 @@
+require_relative 'config/boot'
+require_relative '<%= @app_name %>'
+
+namespace :assets do
+  desc "Precompile assets"
+  task :precompile do
+    manifest = ::Sprockets::Manifest.new(<%= @app_class_name %>.assets.index, "#{<%= @app_class_name %>.public_folder}/assets")
+    manifest.compile(<%= @app_class_name %>.assets_manifest)
+  end
+
+  desc "Clean assets"
+  task :clean do
+    FileUtils.rm_rf("#{<%= @app_class_name %>.public_folder}/assets")
+  end
+end
+<% if @with_database %>
+namespace :db do
+  desc "Run migrations"
+  task :migrate, [:version] do |t, args|
+    Sequel.extension :migration
+    db = Sequel.connect(YAML.load_file("#{Sinator::ROOT}/config/database.yml")[ENV['APP_ENV']])
+    migration_path = "#{Sinator::ROOT}/db/migrations"
+
+    if args[:version]
+      puts "Migrating to version #{args[:version]}"
+      Sequel::Migrator.run(db, migration_path, target: args[:version].to_i)
+    else
+      puts "Migrating to latest"
+      Sequel::Migrator.run(db, migration_path)
+    end
+  end
+end
+<% end %>

data/lib/sinator/templates/app/routes/home.erb

@@ -0,0 +1,6 @@
+class <%= @app_class_name %>
+  get '/' do
+    @home = "Hello World from app/routes/home.rb"
+    erb :"home/index"
+  end
+end

data/lib/sinator/templates/app/views/home/index.erb

@@ -0,0 +1 @@
+<%= @home %>

data/lib/sinator/templates/app/views/layout.erb

@@ -0,0 +1,21 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
+    <title>My Title</title>
+    <meta name="description" content="my description">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+
+    <link rel="apple-touch-icon" href="apple-touch-icon.png">
+    <link rel="stylesheet" type="text/css" href="assets/app.css">
+    <script src="assets/app.js"></script>
+  </head>
+  <body>
+    <!--[if lt IE 8]>
+        <p class="browserupgrade">You are using an <strong>outdated</strong> browser. Please <a href="http://browsehappy.com/">upgrade your browser</a> to improve your experience.</p>
+    <![endif]-->
+
+    <%= yield %>
+  </body>
+</html>

data/lib/sinator/templates/app.erb

@@ -0,0 +1,71 @@
+<%= "require 'yaml'\n\n" if @with_database -%>
+class <%= @app_class_name %> < Sinatra::Application
+  use Rack::Session::EncryptedCookie,
+    secret: '<%= SecureRandom.hex 32 %>'
+
+  set :app_file, __FILE__
+  set :server, :puma
+  set :views, Proc.new { File.join(root, "app/views") }
+  set :assets, Sprockets::Environment.new
+  set :assets_manifest, %w(app.js app.css)
+  use Rack::Csrf, raise: true
+
+<% if @with_database -%>
+  configure do
+    Sequel::Database.extension :pagination
+    Sequel::Model.plugin :timestamps
+    Sequel::Model.plugin :auto_validations,
+      not_null: :presence, unique_opts: { only_if_modified: true }
+
+    assets.append_path 'assets/stylesheets'
+    assets.append_path 'assets/javascripts'
+  end
+
+  configure :development do
+    require 'sinatra/reloader'
+    require 'logger'
+
+    register Sinatra::Reloader
+    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))['development'],
+      loggers: [Logger.new($stdout)]
+
+    get '/assets/*' do
+      env['PATH_INFO'].sub!('/assets', '')
+      settings.assets.call(env)
+    end
+  end
+
+  configure :test do
+    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))['test']
+  end
+
+  configure :production do
+    # Serve assets via Nginx or Apache
+    disable :static
+
+    assets.js_compressor  = :uglify
+    assets.css_compressor = :sass
+    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))['production']
+  end
+<% else -%>
+  configure do
+    assets.append_path 'assets/stylesheets'
+    assets.append_path 'assets/javascripts'
+  end
+
+  configure :development do
+    get '/assets/*' do
+      env['PATH_INFO'].sub!('/assets', '')
+      settings.assets.call(env)
+    end
+  end
+
+  configure :production do
+    # Serve assets via Nginx or Apache
+    disable :static
+
+    assets.js_compressor  = :uglify
+    assets.css_compressor = :sass
+  end
+<% end -%>
+end

data/lib/sinator/templates/assets/javascripts/app.js

@@ -0,0 +1,2 @@
+//= require plugins
+//= require main

data/lib/sinator/templates/assets/javascripts/main.js

@@ -0,0 +1 @@
+/* custom js */

data/lib/sinator/templates/assets/javascripts/plugins.js

@@ -0,0 +1,24 @@
+// Avoid `console` errors in browsers that lack a console.
+(function() {
+    var method;
+    var noop = function () {};
+    var methods = [
+        'assert', 'clear', 'count', 'debug', 'dir', 'dirxml', 'error',
+        'exception', 'group', 'groupCollapsed', 'groupEnd', 'info', 'log',
+        'markTimeline', 'profile', 'profileEnd', 'table', 'time', 'timeEnd',
+        'timeline', 'timelineEnd', 'timeStamp', 'trace', 'warn'
+    ];
+    var length = methods.length;
+    var console = (window.console = window.console || {});
+
+    while (length--) {
+        method = methods[length];
+
+        // Only stub undefined methods.
+        if (!console[method]) {
+            console[method] = noop;
+        }
+    }
+}());
+
+// Place any jQuery/helper plugins in here.

data/lib/sinator/templates/assets/stylesheets/app.css.scss

@@ -0,0 +1 @@
+//= require main

data/lib/sinator/templates/assets/stylesheets/main.css.scss

@@ -0,0 +1,8 @@
+/* custom css */
+
+.browserupgrade {
+  margin: 0.2em 0;
+  background: #ccc;
+  color: #000;
+  padding: 0.2em 0;
+}

data/lib/sinator/templates/config/application.rb

@@ -0,0 +1,7 @@
+%w{/app/models /app/helpers /app/routes}.each do |dir|
+  resource_dir = Sinator::ROOT + dir
+
+  Dir[File.join(resource_dir, '**/*.rb')].each do |file|
+    require file
+  end
+end

data/lib/sinator/templates/config/boot.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] ||= 'development'
+
+require 'rubygems'
+require 'bundler'
+
+Bundler.require :default, ENV['RACK_ENV'].to_sym
+
+module Sinator
+  ROOT = File.expand_path('../../', __FILE__)
+end

data/lib/sinator/templates/config/database.yml

@@ -0,0 +1,8 @@
+# http://sequel.jeremyevans.net/rdoc/files/doc/opening_databases_rdoc.html
+#
+development:
+  adapter: postgres
+  host: localhost
+  database: exampledb_development
+  username: exampleuser
+  password: examplepwd

data/lib/sinator/templates/config/puma/development.erb

@@ -0,0 +1,7 @@
+threads 4, 4
+workers 2
+preload_app!
+
+before_fork do
+  <%= @app_class_name %>::DB.disconnect if defined?(<%= @app_class_name %>::DB)
+end