melodiest 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fcb354a2aa73158378af93b4f18bf9d397f6b0da
-  data.tar.gz: b29f697ff27ba0ea4095382e41177bd47354b942
+  metadata.gz: 93b02593c830fd50c38d34209b6f17ed12526729
+  data.tar.gz: 03253903a834bb4a6ecea68be9c3a10e2271025a
 SHA512:
-  metadata.gz: 951a2c2a88bcbcd9432fa667ac753a98663f88a19805a98564746e9d78bb7752f4f21065e64acb7d4ad6ad4811a1ae9abe57a65e67de5a40adabe707a63a3469
-  data.tar.gz: 5560623ecda83e4834900fffabf61960a3e8ca08a879cb339a39181c571b320857ec6706cc07cde608f72b52c2bf6df95ffbd41a97657f1af847441a189e5e1f
+  metadata.gz: 591c75d518583203dbf71107496474c838c59c661871213a7c5cf8a6ceea1c3c4a8b6a080ed7fd8397c4a9f237faf3d2b672cafd0d4941429578956b782aa073
+  data.tar.gz: cb2ef996bafaa561fcac7a5fe5b81856a1a631339a7d75687c00fc33cebd90ed6c43bb6e6db68c14125c96c97b4c05ab27b0971332ced5686f5b73c4dc41bed6

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+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

data/README.md

@@ -4,7 +4,6 @@ Melodiest is [Sinatra](http://www.sinatrarb.com/) application boilerplate. It pr
 
 ### Installation
 
-
 ```ruby
 gem install melodiest
 ```
@@ -17,14 +16,19 @@ gem 'melodiest'
 
 ### How to Use
 generate app in current directory without database
+
 ```
 melodiest -n my_app
 ```
+
 generate app in target directory without database
+
 ```
 melodiest -n my_app -t target/dir
 ```
+
 generate app in current directory with database. `-d` option will generate app with `Sequel` orm and PostgreSQL adapter.
+
 ```
 melodiest -n my_app -d
 ```
@@ -34,7 +38,6 @@ Because Melodiest is already required Sinatra, you don't have to require 'sinatr
 
 `Melodiest::Application` is subclass from `Sinatra::Application` and by default is using configuration from `Melodiest::Setting.setup` method.
 
-
 ```ruby
 # my_app.rb
 
@@ -43,65 +46,86 @@ class App < Melodiest::Application
   ...
 end
 ```
+
 ### Example Usage
-This example assume that PostgreSQL is already running and .
+This example assume that PostgreSQL is already running and desired database is already exist.
+For complete example see [github.com/kuntoaji/todo_melodiest](https://github.com/kuntoaji/todo_melodiest)
   1. run `melodiest -n my_app -d`
   2. cd `my_app`
   3. run `bundle install`
   4. create `config/database.yml` and configure your database setting
   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
+  
+  ```ruby
+  Sequel.migration do
+    up do
+      create_table(:artists) do
+        primary_key :id
+        String :name, :null=>false
+      end
     end
-  end
   
-  down do
-    drop_table(:artists)
+    down do
+      drop_table(:artists)
+    end
   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 '/' do
-    "hello world!"
+  
+  ```ruby
+  class Artist < Sequel::Model
   end
+  ```
+  
+  8. create file `app/routes/artists.rb` and put the following code:
+  
+  ```ruby
+  class MyApp
+    get '/' do
+      "hello world!"
+    end
 
-  get '/artists' do
-    # for example purpose :)
-    artist = Artist.new
-    artist.name = 'Melody'
-    artist.save
+    get '/artists' do
+      @artists = Artist.all
+      erb :"artists/index"
+    end
     
-    @artists = Artist.all
-    erb :"artists/index"
+    post '/artists' do
+      @artist = Artist.new
+      @artist.name = params[:name]
+      @artist.save
+      
+      redirect '/artists'
+    end
   end
-end
-```
+  ```
+  
   9. create file `app/views/artists/index.erb` and put the following code:
-```erb
-<h1>List of Artist</h1>
-<% @artists.each do |artist| %>
-  <li><%= artist.name %></li>
-<% end %>
-```
-  10. run the server `bundle exec rackup`
-  11. open url `localhost:9292/artists`
-
+  
+  ```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 thin start`
+  11. open url `localhost:3000/artists`
 
 ### Default Configuration
 
   * `Sinatra::Reloader` in development environment only
+  * `Thin` as default web server
   * `Rack::Session::EncryptedCookie`
   * `Rack::Csrf`
   * `Sequel` ORM

data/lib/melodiest.rb

@@ -1,5 +1,4 @@
 require 'sinatra/base'
-require 'sinatra/reloader'
 require 'encrypted_cookie'
 require 'melodiest/setting'
 
@@ -9,6 +8,7 @@ module Melodiest
 
     # http://www.sinatrarb.com/contrib/reloader.html
     configure :development do
+      require 'sinatra/reloader'
       register Sinatra::Reloader
     end
   end

data/lib/melodiest/command.rb

@@ -5,8 +5,9 @@ module Melodiest
 
   class Command
     def self.parse(options)
+      options = %w(--help) if options.empty? || options.nil?
       args = {}
-      result = ""
+      result = nil
 
       option_parser = OptionParser.new do |opts|
         opts.banner = "Usage: melodiest [options]"
@@ -52,7 +53,7 @@ module Melodiest
       msg = "#{args[:name]} is successfully generated"
       msg << " in #{args[:target]}" if args[:target]
 
-      msg 
+      msg
     end
   end
 

data/lib/melodiest/generator.rb

@@ -26,6 +26,7 @@ module Melodiest
         f.write("source 'https://rubygems.org'\n\n")
         f.write("gem 'melodiest', '#{Melodiest::VERSION}'\n")
         f.write("gem 'thin'\n")
+        f.write("gem 'tux'\n")
         f.write("gem 'rack_csrf', require: 'rack/csrf'")
 
         if @with_database
@@ -52,10 +53,19 @@ module Melodiest
 
       if @with_database
         content[:yaml] = "require 'yaml'\n\n"
-        content[:database] = "    Sequel.connect YAML.load_file(File.expand_path(\"../config/database.yml\", __FILE__))[settings.environment.to_s]\n"
+        content[:database] =  "  configure :development, :test do\n"
+        content[:database] << "    require 'logger'\n\n"
+        content[:database] << "    Sequel.connect YAML.load_file(File.expand_path(\"../config/database.yml\", __FILE__))[settings.environment.to_s],\n"
+        content[:database] << "      loggers: [Logger.new($stdout)]\n"
+        content[:database] << "  end\n\n"
+        content[:database] << "  configure :production do\n"
+        content[:database] << "    Sequel.connect YAML.load_file(File.expand_path(\"../config/database.yml\", __FILE__))['production']\n"
+        content[:database] << "  end\n"
       else
         content[:yaml] = nil
-        content[:database] = "    # Load up database and such\n"
+        content[:database] =  "  configure do\n"
+        content[:database] << "    # Load up database and such\n"
+        content[:database] << "  end\n"
       end
 
       File.open "#{@destination}/#{@app_name}.rb", "w" do |f|
@@ -65,9 +75,7 @@ module Melodiest
         f.write("  set :app_file, __FILE__\n")
         f.write("  set :views, Proc.new { File.join(root, \"app/views\") }\n\n")
         f.write("  use Rack::Csrf, raise: true\n\n")
-        f.write("  configure do\n")
         f.write(content[:database])
-        f.write("  end\n")
         f.write("end\n\n")
         f.write("%w{app/models app/routes}.each do |dir|\n")
         f.write("  Dir[File.join(dir, '**/*.rb')].each do |file|\n")
@@ -76,6 +84,8 @@ module Melodiest
         f.write("end\n")
       end
 
+      FileUtils.mkdir "#{@destination}/public"
+
       app_dir = "#{@destination}/app"
       ["", "/routes", "/models", "/views"].each do |dir|
         FileUtils.mkdir "#{app_dir}/#{dir}"

data/lib/melodiest/setting.rb

@@ -1,11 +1,7 @@
 module Melodiest
   module Setting
     def setup(cookie_secret, options={})
-      settings = {
-        server: 'thin'
-      }.merge(options)
-
-      settings.each do |key, value|
+      {server: 'thin'}.merge(options).each do |key, value|
         set key, value
       end
 

data/lib/melodiest/version.rb

@@ -1,3 +1,3 @@
 module Melodiest
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/melodiest.gemspec

@@ -4,8 +4,8 @@ Gem::Specification.new do |s|
   s.name        = 'melodiest'
   s.version     = Melodiest::VERSION
   s.date        = Date.today.to_s
-  s.summary     = "Sinatra application boilerplate"
-  s.description = "Melodiest provides generator and contains minimalist configuration to develop application with Sinatra"
+  s.summary     = "Sinatra application boilerplate generator"
+  s.description = "Melodiest provides generator and contains minimal configuration to develop application with Sinatra"
   s.author      = 'Kunto Aji Kristianto'
   s.email       = 'kunto.aji.kr@slackware-id.org'
   s.files       = `git ls-files -z`.split("\x0")

data/spec/melodiest/command_spec.rb

@@ -51,7 +51,16 @@ describe Melodiest::Command do
       it "does nothing" do
         app = Melodiest::Command.parse %w(--target /tmp/melodiest)
 
-        expect(app).to be_empty
+        expect(app).to be_nil
+      end
+    end
+
+    context "when has no option" do
+      it "uses --help option by default" do
+        help = Melodiest::Command.parse []
+
+        expect(help).to include "Usage: melodiest [options]"
+        expect(help).to include "Print this help"
       end
     end
   end

data/spec/melodiest/generator_spec.rb

@@ -50,6 +50,7 @@ describe Melodiest::Generator do
         expect(file_content).to include "source 'https://rubygems.org'"
         expect(file_content).to include "gem 'melodiest', '#{Melodiest::VERSION}'"
         expect(file_content).to include "gem 'thin'"
+        expect(file_content).to include "gem 'tux'"
         expect(file_content).to include "gem 'rack_csrf', require: 'rack/csrf'"
         expect(file_content).to_not include "gem 'sequel'"
         expect(file_content).to_not include "gem 'sequel_pg'"
@@ -89,7 +90,7 @@ describe Melodiest::Generator do
     let(:secret) { "supersecretcookiefromgenerator" }
     before { allow(SecureRandom).to receive(:hex).with(32).and_return(secret) }
 
-    it "generates <app_name>.rb" do
+    it "generates <app_name>.rb, public dir, and app dir" do
       FileUtils.rm_r @dest if Dir.exists?(@dest)
       generator.generate_app
       app_file = "#{target_dir}/my_app.rb"
@@ -119,6 +120,7 @@ DOC
 
       expect(File.exists?(app_file)).to be_truthy
       expect(file_content).to eq expected_file_content
+      expect(Dir.exists?("#{target_dir}/public")).to be_truthy
       expect(Dir.exists?("#{target_dir}/app")).to be_truthy
       expect(Dir.exists?("#{target_dir}/app/routes")).to be_truthy
       expect(Dir.exists?("#{target_dir}/app/models")).to be_truthy
@@ -144,8 +146,15 @@ class MyApp < Melodiest::Application
 
   use Rack::Csrf, raise: true
 
-  configure do
-    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))[settings.environment.to_s]
+  configure :development, :test do
+    require 'logger'
+
+    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))[settings.environment.to_s],
+      loggers: [Logger.new($stdout)]
+  end
+
+  configure :production do
+    Sequel.connect YAML.load_file(File.expand_path("../config/database.yml", __FILE__))['production']
   end
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: melodiest
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kunto Aji Kristianto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-17 00:00:00.000000000 Z
+date: 2015-06-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,8 +94,8 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.0.4
-description: Melodiest provides generator and contains minimalist configuration to
-  develop application with Sinatra
+description: Melodiest provides generator and contains minimal configuration to develop
+  application with Sinatra
 email: kunto.aji.kr@slackware-id.org
 executables:
 - melodiest
@@ -122,7 +122,6 @@ files:
 - spec/melodiest/command_spec.rb
 - spec/melodiest/generator_spec.rb
 - spec/melodiest/setting_spec.rb
-- spec/melodiest_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/kuntoaji/melodiest
 licenses:
@@ -147,5 +146,5 @@ rubyforge_project:
 rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
-summary: Sinatra application boilerplate
+summary: Sinatra application boilerplate generator
 test_files: []

data/spec/melodiest_spec.rb

@@ -1,7 +0,0 @@
-describe Melodiest::Application do
-  context ".extensions" do
-    it "has reloader extension" do
-      expect(app.extensions.include?(Sinatra::Reloader)).to be_truthy
-    end
-  end
-end