melodiest 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00c23e4c16d216fa1999cc6ad4f21c7f4e4d7e6e
-  data.tar.gz: 3cbde05684e9a5b653cd617e1614711322da8c0f
+  metadata.gz: 61a1ca9f0d801c00782ea2292bd6a76e68af04e1
+  data.tar.gz: 70dc5c6791cb7a7cc97fd6fb4ff0a96e7438d7f9
 SHA512:
-  metadata.gz: 18e669f816f85dcaeaa2337d46f04c96c48c75927e80acb116a3ee4016cae80e63a3bafab49804d7b6a324b31caadb31bba6a8bd0b97c5d90ba2f28de4bfe977
-  data.tar.gz: 0c8fa8028ac85f7b9d8cb01dcd9578163ddb16c5ff2d424ad56c2be123b08f0bf1cd8fb52ad27f39c15f19381560a516d6d3d6ed13422638d5069362a65ffa3f
+  metadata.gz: b24717b4ecfd760e49e7ee8522ee756ee0aae290f05c528e40c83687df3f3118703aecc175530f7b05aa8f3fcd31984133c659f1b0834f0183139eb69b03aaa7
+  data.tar.gz: 39816f9ac983ed88f7167daeb73e8791a40ff5d875301b21270561c3692bee43af1b2295ec257e86488857a76d99800196d44636fcf0fcaf57477f03d8b6145d

data/Gemfile

@@ -1,3 +1,5 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
+
+gem 'fakefs', '0.6.7', require: 'fakefs/safe'
 
 gemspec

data/Gemfile.lock

@@ -1,16 +1,20 @@
 PATH
   remote: .
   specs:
-    melodiest (0.1.0)
+    melodiest (0.2.0)
       sinatra (= 1.4.5)
+      sinatra-contrib (= 1.4.2)
       thin (= 1.6.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    backports (3.6.4)
     daemons (1.1.9)
     diff-lcs (1.2.5)
-    eventmachine (1.0.4)
+    eventmachine (1.0.7)
+    fakefs (0.6.7)
+    multi_json (1.10.1)
     rack (1.6.0)
     rack-protection (1.5.3)
       rack
@@ -32,6 +36,13 @@ GEM
       rack (~> 1.4)
       rack-protection (~> 1.4)
       tilt (~> 1.3, >= 1.3.4)
+    sinatra-contrib (1.4.2)
+      backports (>= 2.0)
+      multi_json
+      rack-protection
+      rack-test
+      sinatra (~> 1.4.0)
+      tilt (~> 1.3)
     thin (1.6.3)
       daemons (~> 1.0, >= 1.0.9)
       eventmachine (~> 1.0)
@@ -43,6 +54,7 @@ PLATFORMS
 
 DEPENDENCIES
   bundler (~> 1.7)
+  fakefs (= 0.6.7)
   melodiest!
   rack-test (= 0.6.3)
   rspec (= 3.1.0)

data/README.md

@@ -16,40 +16,58 @@ gem 'melodiest'
 ```
 
 ### How to Use
+#### Command
+generate app in current directory
+```
+melodiest -n my_app
+```
+generate app in target directory
+```
+melodiest -n my_app -d target/dir
+```
 
+#### Example Code
 Because Melodiest is already required Sinatra, you don't have to require 'sinatra' anymore, just require 'melodiest'.
 
 `Melodiest::Application` is subclass from `Sinatra::Application` and by default is using configuration from `Melodiest::Setting.setup` method.
 
 
 ```ruby
-# mysinatraapp.rb
+# my_app.rb
 
-require 'melodiest'
-require 'melodiest/auth'
+require 'melodiest/auth/http'
 
-class App < Melodiest::Application
+class App < Melodiest::Application'
+  configure do
+    # Load up database and such
+  end
+  
   helpers Melodiest::Auth::Http
+end
 
-  get "/" do
-    "hello world!"
-  end
+# app/routes/my_routes.rb
 
-  get "/protected" do
-    authorized! "myhttpauthusername", "myhttpauthpassword"
-  end
+get "/" do
+  "hello world!"
+end
 
+get "/protected" do
+  authorized! "myhttpauthusername", "myhttpauthpassword"
+  "welcome!"
 end
 
 ```
+#### Run the server
+```
+bundle exec rackup
+```
 
-#### Configuration
 
-Configuration
+### Configuration
 
-  * `set :server, 'thin'`
+See [melodiest/config.yml](https://github.com/kuntoaji/melodiest/blob/master/lib/melodiest/config.yml)
 
-#### Helpers
+### Helpers
 
 Helper methods
 

data/bin/melodiest

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

data/lib/melodiest/command.rb

@@ -0,0 +1,53 @@
+require 'optparse'
+require_relative 'generator'
+
+module Melodiest
+
+  class Command
+    def self.parse(options)
+      args = {name: nil, dir: nil}
+      result = ""
+
+      option_parser = OptionParser.new do |opts|
+        opts.banner = "Usage: melodiest [options]"
+
+        opts.on("-h", "--help", "Print this help") do
+          result = opts.to_s
+        end
+
+        opts.on("-v", "--version", "Show version") do
+          result = Melodiest::VERSION
+        end
+
+        opts.on("-nNAME", "--name=NAME", "generate app with name from this option") do |name|
+          args[:name] = name
+        end
+
+        opts.on("-dDIR", "--dir=DIR", "instead of current directory, generate app in target DIR") do |dir|
+          args[:dir] = dir
+        end
+
+      end
+
+      option_parser.parse! options
+
+      result = Command.run(args[:name], args[:dir]) unless args[:name].nil?
+
+      result
+    end
+
+    def self.run(app_name, target_dir)
+      generator = Melodiest::Generator.new app_name, target_dir
+
+      generator.generate_gemfile
+      generator.generate_bundle_config
+      generator.generate_app
+
+      msg = "#{app_name} is successfully generated"
+      msg << " in #{target_dir}" if target_dir
+
+      msg 
+    end
+  end
+
+end

data/lib/melodiest/config.yml

@@ -0,0 +1 @@
+server: thin

data/lib/melodiest/generator.rb

@@ -0,0 +1,61 @@
+require 'fileutils'
+require_relative 'version'
+
+module Melodiest
+
+  class Generator
+    attr_accessor :destination, :app_name, :app_class_name
+
+    def initialize(app_name, destination=nil)
+      @app_name = app_name
+      @app_class_name = app_name.split("_").map{|s| s.capitalize }.join("")
+      destination = destination ? "#{destination}/#{@app_name}" : @app_name
+
+      unless File.directory?(destination)
+        FileUtils.mkdir_p(destination)
+      end
+
+      @destination = File.expand_path(destination)
+    end
+
+    def generate_gemfile
+      File.open "#{@destination}/Gemfile", "w" do |f|
+        f.write("source 'https://rubygems.org'\n\n")
+        f.write("gem 'melodiest', '#{Melodiest::VERSION}'")
+      end
+    end
+
+    def generate_bundle_config
+      File.open "#{@destination}/config.ru", "w" do |f|
+        f.write("require 'rubygems'\n")
+        f.write("require 'bundler'\n\n")
+        f.write("Bundler.require\n\n")
+        f.write("require './#{@app_name}'\n")
+        f.write("run #{@app_class_name}\n")
+      end
+    end
+
+    # https://github.com/sinatra/sinatra-book/blob/master/book/Organizing_your_application.markdown
+    def generate_app
+      File.open "#{@destination}/#{@app_name}.rb", "w" do |f|
+        f.write("class #{app_class_name} < Melodiest::Application\n")
+        f.write("  configure do\n")
+        f.write("    # Load up database and such\n")
+        f.write("  end\n")
+        f.write("end\n\n")
+        f.write("# Load all route files\n")
+        f.write("Dir[File.dirname(__FILE__) + \"/app/routes/**\"].each do |route|\n")
+        f.write("  require route\n")
+        f.write("end\n")
+      end
+
+      FileUtils.mkdir_p "#{@destination}/db/migrations"
+
+      app_dir = "#{@destination}/app"
+      ["", "/routes", "/models", "/views"].each do |dir|
+        FileUtils.mkdir "#{app_dir}/#{dir}"
+      end
+    end
+  end
+
+end

data/lib/melodiest/setting.rb

@@ -1,7 +1,8 @@
 module Melodiest
   module Setting
     def setup
-      set :server, 'thin'
+      register Sinatra::ConfigFile
+      config_file File.expand_path('../config.yml', __FILE__)
     end
   end
 end

data/lib/melodiest/version.rb

@@ -1,3 +1,3 @@
 module Melodiest
-  VERSION = '0.1.1'
+  VERSION = '0.2.0'
 end

data/lib/melodiest.rb

@@ -1,12 +1,16 @@
 require 'sinatra'
+require 'sinatra/config_file'
+require 'sinatra/reloader'
 require 'melodiest/setting'
 
 module Melodiest
   class Application < Sinatra::Application
     extend Setting
+    setup
 
-    configure do
-      setup
+    # http://www.sinatrarb.com/contrib/reloader.html
+    configure :development do
+      register Sinatra::Reloader
     end
   end
 end

data/melodiest.gemspec

@@ -9,6 +9,7 @@ Gem::Specification.new do |s|
   s.author      = 'Kunto Aji Kristianto'
   s.email       = 'kunto.aji.kr@slackware-id.org'
   s.files       = `git ls-files -z`.split("\x0")
+  s.executables << 'melodiest'
   s.homepage    = 'http://github.com/kuntoaji/melodiest'
   s.license     = 'MIT'
 
@@ -16,5 +17,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rspec', '3.1.0'
   s.add_development_dependency 'rack-test', '0.6.3'
   s.add_runtime_dependency 'sinatra', '1.4.5'
+  s.add_runtime_dependency 'sinatra-contrib', '1.4.2'
   s.add_runtime_dependency 'thin', '1.6.3'
 end

data/spec/melodiest/{auth_spec.rb → auth/http_spec.rb}

@@ -1,5 +1,3 @@
-require_relative '../../lib/melodiest/auth'
-
 describe Melodiest::Auth::Http do
   it "respond to authorized!" do
     expect(Melodiest::Auth::Http.method_defined?(:authorized!)).to be_truthy

data/spec/melodiest/command_spec.rb

@@ -0,0 +1,42 @@
+require_relative '../../lib/melodiest/command'
+require 'fakefs/spec_helpers'
+
+describe Melodiest::Command do
+  include FakeFS::SpecHelpers
+
+  describe "parse" do
+    it "has --help option" do
+      help = Melodiest::Command.parse %w(--help)
+
+      expect(help).to include "Usage: melodiest [options]"
+      expect(help).to include "Print this help"
+    end
+
+    it "has --version option" do
+      version = Melodiest::Command.parse %w(--version)
+
+      expect(version).to include Melodiest::VERSION
+    end
+
+    it "has --name option as required option to generate application" do
+      app = Melodiest::Command.parse %w(--name my_app)
+
+      expect(app).to include "my_app is successfully generated"
+    end
+
+    it "has --directory option as target directory" do
+      app = Melodiest::Command.parse %w(-n my_app --dir /tmp)
+
+      expect(app).to include "my_app is successfully generated in /tmp"
+      expect(Dir.exists?("/tmp/my_app")).to be_truthy
+    end
+
+    context "when has no --name option and only --dir option" do
+      it "does nothing" do
+        app = Melodiest::Command.parse %w(--dir /tmp/melodiest)
+
+        expect(app).to be_empty
+      end
+    end
+  end
+end

data/spec/melodiest/generator_spec.rb

@@ -0,0 +1,88 @@
+require_relative '../../lib/melodiest/generator'
+require 'fakefs/spec_helpers'
+
+describe Melodiest::Generator do
+  include FakeFS::SpecHelpers
+
+  let(:dest) { "/tmp/melodiest" }
+  let(:app) { "my_app" }
+  let(:generator) { Melodiest::Generator.new app, dest }
+
+  it "sets app_name" do
+    expect(generator.app_name).to eq app
+  end
+
+  it "sets app_class_name" do
+    expect(generator.app_class_name).to eq "MyApp"
+  end
+
+  it "has default destination path app_name" do
+    expect(Melodiest::Generator.new(app).destination).to eq File.expand_path(app)
+  end
+
+  it "sets new destination path even if it's not exist yet" do
+    expect("/tmp/melodiest/my_app").to eq "#{dest}/#{app}"
+  end
+
+  describe "#generate_gemfile" do
+    let(:gemfile) { "#{dest}/#{app}/Gemfile" }
+
+    it "should generate Gemfile with correct content" do
+      generator.generate_gemfile
+      file_content = File.read(gemfile)
+
+      expect(File.exists?(gemfile)).to be_truthy
+      expect(file_content).to include "source 'https://rubygems.org'"
+      expect(file_content).to include "gem 'melodiest', '#{Melodiest::VERSION}'"
+    end
+  end
+
+  describe "#generate_bundle_config" do
+    let(:bundle_config) { "#{dest}/#{app}/config.ru" }
+
+    it "should generate config.ru with correct content" do
+      generator.generate_bundle_config
+      file_content = File.read(bundle_config)
+
+      expect(File.exists?(bundle_config)).to be_truthy
+      expect(file_content).to include "require 'rubygems'"
+      expect(file_content).to include "require 'bundler'"
+      expect(file_content).to include "Bundler.require"
+      expect(file_content).to include "require './my_app'"
+      expect(file_content).to include "run MyApp"
+    end
+  end
+
+  describe "#generate_app" do
+    let(:target_dir) { "#{dest}/#{app}" }
+
+    it "generates <app_name>.rb" do
+      generator.generate_app
+      app_file = "#{target_dir}/my_app.rb"
+      file_content = File.read(app_file)
+
+      expected_file_content =
+<<DOC
+class MyApp < Melodiest::Application
+  configure do
+    # Load up database and such
+  end
+end
+
+# Load all route files
+Dir[File.dirname(__FILE__) + "/app/routes/**"].each do |route|
+  require route
+end
+DOC
+
+      expect(File.exists?(app_file)).to be_truthy
+      expect(file_content).to eq expected_file_content
+      expect(Dir.exists?("#{target_dir}/db/migrations")).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
+      expect(Dir.exists?("#{target_dir}/app/views")).to be_truthy
+    end
+  end
+
+end

data/spec/melodiest/setting_spec.rb

@@ -1,5 +1,3 @@
-require_relative '../../lib/melodiest/setting'
-
 describe Melodiest::Setting do
   it "respond to setup" do
     expect(Melodiest::Setting.method_defined?(:setup)).to be_truthy

data/spec/melodiest_spec.rb

@@ -1,9 +1,17 @@
-require_relative '../lib/melodiest'
-
 describe Melodiest::Application do
+  it "has config.yml" do
+    expect(File.exists?(File.expand_path('../../lib/melodiest/config.yml', __FILE__))).to be_truthy
+  end
+
   context ".settings" do
     it "use thin as server" do
       expect(Melodiest::Application.settings.server).to eq("thin")
     end
   end
+
+  context ".extensions" do
+    it "has reloader extension" do
+      expect(app.extensions.include?(Sinatra::Reloader)).to be_truthy
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,5 +1,7 @@
 ENV['RACK_ENV'] = 'test'
 require 'rack/test'
+require_relative '../lib/melodiest'
+require_relative '../lib/melodiest/auth/http'
 
 # See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
 RSpec.configure do |config|
@@ -87,3 +89,7 @@ def app
   Melodiest::Application
 end
 
+def gem_root_path
+  File.expand_path "../../", __FILE__
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: melodiest
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Kunto Aji Kristianto
@@ -66,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.4.5
+- !ruby/object:Gem::Dependency
+  name: sinatra-contrib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.4.2
 - !ruby/object:Gem::Dependency
   name: thin
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +96,8 @@ dependencies:
         version: 1.6.3
 description: Sinatra configuration boilerplate
 email: kunto.aji.kr@slackware-id.org
-executables: []
+executables:
+- melodiest
 extensions: []
 extra_rdoc_files: []
 files:
@@ -92,12 +107,18 @@ files:
 - Gemfile.lock
 - LICENSE.txt
 - README.md
+- bin/melodiest
 - lib/melodiest.rb
-- lib/melodiest/auth.rb
+- lib/melodiest/auth/http.rb
+- lib/melodiest/command.rb
+- lib/melodiest/config.yml
+- lib/melodiest/generator.rb
 - lib/melodiest/setting.rb
 - lib/melodiest/version.rb
 - melodiest.gemspec
-- spec/melodiest/auth_spec.rb
+- spec/melodiest/auth/http_spec.rb
+- spec/melodiest/command_spec.rb
+- spec/melodiest/generator_spec.rb
 - spec/melodiest/setting_spec.rb
 - spec/melodiest_spec.rb
 - spec/spec_helper.rb
@@ -121,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Sinatra configuration boilerplate