grape-starter 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ca163007e1cc40a05ddb7d54bcedb07e092d6ae
-  data.tar.gz: 4bdd0c412bbe5f0830e7171f007e41249a518060
+  metadata.gz: 2ca5b09c3e3577d7a93143d6fff88b91aecfd926
+  data.tar.gz: 8cd9948d9aa98b6c12cd118cca08d3d1858ad62f
 SHA512:
-  metadata.gz: 0f62704c5d7e8ed9bdc1a1fc1bdff82358467013dd6ddcf8ceda4d8582adeaab37b6e70198c4cbcdd63378f9f90abce55724e5d35ee403208526407a3f7c2a86
-  data.tar.gz: 2bf01d9d49175e5175736775c626b1239913a25b6c54585740ad247c8dbf059a784d2f334e50fb0a573ce4fc11b7761fe01f7d9a1faecae15b596c74550cbe92
+  metadata.gz: 22665163096ced52badfbdd0b99e2373108f18c0a6ae68002bad33d525b75b408d807fd9cca10c91dd49631fbef466d85c69bd9a72f39fddabd32b022ad00490
+  data.tar.gz: 83e99286b0d75e30ea70b80f7430918179178982c5dd4ea1958ce9632cd20c13ee6262f908ab742cea05b9d3778344c6723e84d69560164bf9761f2f8ce7c9d8

data/README.md

@@ -1,4 +1,4 @@
-[![Codeship Status for LeFnord/grape-starter](https://app.codeship.com/projects/91e08e60-9600-0134-5571-4a8607aa1ae3/status?branch=master)](https://app.codeship.com/projects/186901)
+[![Build Status](https://travis-ci.org/LeFnord/grape-starter.svg?branch=master)](https://travis-ci.org/LeFnord/grape-starter)
 [![Gem Version](https://badge.fury.io/rb/grape-starter.svg)](https://badge.fury.io/rb/grape-starter)
 [![Inline docs](http://inch-ci.org/github/LeFnord/grape-starter.svg?branch=master)](http://inch-ci.org/github/LeFnord/grape-starter)
 
@@ -8,6 +8,7 @@
 Is a tool to help you to build up a skeleton for a [Grape](http://github.com/ruby-grape/grape) API mounted on [Rack](https://github.com/rack/rack) ready to run.
 [grape-swagger](http://github.com/ruby-grape/grape-swagger) would be used to generate a  [OAPI](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) compatible documentation, which could be shown with [ReDoc](https://github.com/Rebilly/ReDoc).
 
+![ReDoc demo](doc/re-doc.png)
 
 ## Why the next one?
 
@@ -56,9 +57,10 @@ This command creates a folder named `awesome_api` containing the skeleton. With
 To run it, go into awesome_api folder, start the server
 ```
 $ cd awesome_api
-$ ./script/server
+$ ./script/server *port
 ```
-the API is now accessible under: [http://localhost:9292/api/v1/root](http://localhost:9292/api/v1/root)
+the API is now accessible under: [http://localhost:9292/api/v1/root](http://localhost:9292/api/v1/root)  
+the documentation of it under: [http://localhost:9292/](http://localhost:9292/)
 
 More could be found in [README](template/README.md).
 
@@ -87,3 +89,8 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/LeFnor
 ## License
 
 The gem is available as open source under the terms of the [MIT License](LICENSE).
+
+### ToDos
+
+- [x] make scripts more configurable
+- [ ] add logging

data/bin/grape-starter

@@ -25,25 +25,26 @@ arg_name 'project name'
 command :new do |c|
 
   c.action do |global_options, _, args|
-    dir = args.empty? ? nil : File.join(Dir.getwd, args.first)
+    dest = args.empty? ? nil : File.join(Dir.getwd, args.first)
 
     case
-    when args.empty? || dir.nil?
-      exit_now! 'no name given: starter new project'
-    when Dir.exist?(dir) && !global_options[:force]
+    when args.empty? || dest.nil?
+      exit_now! 'no name given: grape-starter new project'
+    when Dir.exist?(dest) && !global_options[:force]
       exit_now! 'project exist: -f to overwrite'
-    end
-
-    $stdout.puts "created: #{args.first}"
-    starter_gem = Gem::Specification.find_by_name('grape-starter').gem_dir
-
-    src = File.join(starter_gem, 'template', '.')
-    FileUtils.copy_entry src, dir
-
-    FileUtils.cd(dir) do
-      $stdout.puts `bundle install`
-      $stdout.puts `bundle exec rubocop -a`
-      $stdout.puts `git init`
+    else
+      starter_gem = Gem::Specification.find_by_name('grape-starter').gem_dir
+      src = File.join(starter_gem, 'template', '.')
+
+      Starter::Builder.new!(args.first, src, dest)
+      $stdout.puts "created: #{args.first}"
+
+      # after creating tasks
+      FileUtils.cd(dest) do
+        $stdout.puts `bundle install`
+        $stdout.puts `bundle exec rubocop -a`
+        $stdout.puts `git init`
+      end
     end
   end
 end

data/lib/starter/builder.rb

@@ -12,15 +12,34 @@ module Starter
     extend Template::Endpoints
 
     class << self
-      attr_reader :resource, :set, :force, :entity
+      attr_reader :resource, :set, :force, :entity, :destination
+
+      # would be called on new command
+      # it should do following
+      # 1. copying the template to the new destination
+      # 2. replace names in …
+      #   - script/server
+      #
+      # name - A String as project name
+      # source - A String which provides the template path
+      # destination - A String which provides the new project path
+      def new!(name, source, destination)
+        @resource = name
+        @destination = destination
+
+        FileUtils.copy_entry source, destination
+
+        replace_static(File.join('script','server'))
+      end
+
       # would be called on add command
       #
       # resource - A String as name
       # options - A Hash to provide some optional arguments (default: {})
       #           :set – whitespace separated list of http verbs
-      #                 (default: nil, possible: post, get, put, patch, delete)
-      #           :force - A Boolean, if given existent files should be overwriten (default: nil -> false)
-      #           :entity - A Boolean, if given an entity file would be created (default: nil -> false)
+      #                 (default: nil, possible: post get put patch delete)
+      #           :force - A Boolean, if given existent files should be overwriten (default: false)
+      #           :entity - A Boolean, if given an entity file would be created (default: false)
       def add!(resource, options = {})
         @resource = resource
         @set = options[:set]
@@ -30,7 +49,6 @@ module Starter
         self
       end
 
-      # would also be called on add command,
       # it saves the files
       def save
         created_files = file_list.each_with_object([]) do |new_file, memo|
@@ -63,7 +81,7 @@ module Starter
         remove_mount_point
       end
 
-      # provides the endpoints for he given resource
+      # provides the endpoints for the given resource
       def endpoints
         content(endpoint_set).join("\n\n")
       end
@@ -75,26 +93,45 @@ module Starter
 
       private
 
+      # provides an array of endpoints to for the new resource
+      def endpoint_set
+        crud_set = singular? ? singular_one : crud
+        return crud_set if set.blank?
+
+        crud_set.each_with_object([]) { |x, memo| set.map { |y| memo << x if x.to_s.start_with?(y) } }
+      end
+
+      # provides a file list for the new resource
       def file_list
         standards = %w(api_file lib_file api_spec lib_spec)
 
         entity ? standards + ['entity_file'] : standards
       end
 
+      # raises if resource exist and force == false
       def should_raise?(file)
         raise StandardError, '… resource exists' if File.exist?(file) && !force
       end
 
+      # add project name to static files
+      def replace_static(file)
+        server_file = File.join(destination, file)
+
+        file_foo(server_file) { |content| content.gsub!('{{{grape-starter}}}', "API-#{resource}") }
+      end
+
       def add_mount_point
-        file = read_file(api_base_file_name)
-        add_to_base(file)
-        write_file(api_base_file_name, file)
+        file_foo(api_base_file_name) { |content| add_to_base(content) }
       end
 
       def remove_mount_point
-        file = read_file(api_base_file_name)
-        remove_from_base(file)
-        write_file(api_base_file_name, file)
+        file_foo(api_base_file_name) { |content| remove_from_base(content) }
+      end
+
+      def file_foo(file)
+        content = read_file(file)
+        yield content
+        write_file(file, content)
       end
 
       def save_file(new_file)
@@ -103,13 +140,6 @@ module Starter
         write_file(send(new_file_name), send(new_file.strip_heredoc))
       end
 
-      def endpoint_set
-        crud_set = singular? ? singular_one : crud
-        return crud_set if set.blank?
-
-        crud_set.each_with_object([]) { |x, memo| set.map { |y| memo << x if x.to_s.start_with?(y) } }
-      end
-
       # manipulating API Base file
       # … adding
       def add_to_base(file)
@@ -123,17 +153,22 @@ module Starter
         file.sub!(mount_point, '')
       end
 
+      # content of the given set of files,
+      # returns an array of string
+      def content(set)
+        set.map { |x| send(x) }
+      end
+
+      # general file
+      # … read
       def read_file(file)
         File.read(file)
       end
 
+      # … write
       def write_file(file, content)
         File.open(file, 'w') { |f| f.write(content) }
       end
-
-      def content(set)
-        set.map { |x| send(x) }
-      end
     end
   end
 end

data/lib/starter/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Starter
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

data/template/script/server

@@ -7,8 +7,14 @@ cd "$(dirname "$0")/.."
 test -z "$RACK_ENV" &&
   RACK_ENV='development'
 
+if [ $1 ]; then
+  port=$1
+else
+  port=9292
+fi
+
 if [ "$RACK_ENV" = 'production' ]; then
-  bundle exec thin start -p 9292 -e $RACK_ENV --tag api-starter -d --threaded
+  bundle exec thin start -p $port -e $RACK_ENV --tag {{{grape-starter}}} -d --threaded
 else
-  bundle exec thin start -p 9292 -e $RACK_ENV --tag api-starter -V -D
+  bundle exec thin start -p $port -e $RACK_ENV --tag {{{grape-starter}}} -V -D
 fi

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-19 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -156,6 +156,7 @@ files:
 - README.md
 - Rakefile
 - bin/grape-starter
+- doc/re-doc.png
 - grape-starter.gemspec
 - lib/starter.rb
 - lib/starter/builder.rb