grape-starter 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ce54496d2a64c456a6d1e1a677478fe0bed3067
-  data.tar.gz: 853b3d32ba5bd42c64bafaee58ad03fef82fb67f
+  metadata.gz: 45c1d0a951be87c5be14c08499f38ae04ccfbbdb
+  data.tar.gz: 4b9a797047eaf1271ab0d46a5eb7438043fbddcf
 SHA512:
-  metadata.gz: 5d1210d3be1e31da4a12aaf49a536c49bc6f6fcbbcdd06f6831690048428427745f4d82918f821467041c7b6895119df9166d7fc323605c666df28178697a96f
-  data.tar.gz: d1beec85ca244b47041ff421c96acd47c55db2a154d82ba09dc4e0c9a1f4eddb64bd67bdf135a2627e96e6fa8994aaefbad5f2f395b34ba1560b454516dc7ca2
+  metadata.gz: 3c1d2224a49b34e3a9971c663dfd61acbb82f0f487d6e405ce7c83424d050c5227efe0307327e40599724c5f9264f2b5d8e1e0eec6fad535fe7adc1b87f6a473
+  data.tar.gz: bc11c7f804027886528c7c2872a68d224b6a02c5e335a582709d2260e34678d0715dfe8bdc287b09e5322cd759d9f311d2758949727a7cf62f536b156e72377c

data/.rubocop_todo.yml

@@ -7,7 +7,7 @@
 # versions of RuboCop, may require this file to be generated again.
 
 Metrics/AbcSize:
-  Max: 20
+  Max: 21
 
 Metrics/MethodLength:
   Max: 20

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 - contributions
 
+### 0.8.0
+
+- [#15](https://github.com/LeFnord/grape-starter/pull/15), [2af09…](https://github.com/LeFnord/grape-starter/commit/2af09dddf97f756e96c80c745ee68aad5ab4ccc3) **breaking change** prefix option on create is optional, no default
+- [#12](https://github.com/LeFnord/grape-starter/pull/12) - Add base configuration for ActiveRecord - ([@terry90](https://github.com/terry90))
+
 ### 0.7.0
 
 - [212e6…](https://github.com/LeFnord/grape-starter/commit/212e6245e10598efe286143dac39f46134c58c54) - makes mounting of doc more secure

data/README.md

@@ -31,7 +31,7 @@ with following options:
 ```
 -f, --force                # overwrites existend project
 -p foobar, --prefix=foobar # provide a prefix under which the API can be accessed, default: api
--o sequel, --orm=sequel    # create also needed files and folders for the specified ORM
+-o sequel, --orm=sequel    # create files for the specified ORM, default: sequel, available: activerecord
 ```
 
 This command creates a folder named `awesome_api` containing the skeleton. With following structure:

data/bin/grape-starter

@@ -23,11 +23,10 @@ desc 'Creates initial api skeleton'
 arg_name 'awesome_api'
 command :new do |c|
   c.flag [:p, :prefix],
-         default_value: 'api',
          desc: 'sets the prefix of the API'
   c.flag [:o, :orm],
          default_value: 'sequel',
-         desc: 'prepares for the given ORM (Sequel, …)'
+         desc: 'prepares for the given ORM (Sequel -> sequel, ActiveRecord -> ar)'
 
   c.action do |global_options, options, args|
     dest = args.empty? ? nil : File.join(Dir.getwd, args.first)

data/lib/starter/builder.rb

@@ -28,21 +28,31 @@ module Starter
       # source - A String which provides the template path
       # destination - A String which provides the new project path
       def new!(name, source, destination, options = {})
-        @prefix = options[:p] || 'api'
         @resource = name
         @destination = destination
+        @prefix = options[:p] # can be nil
 
         FileUtils.copy_entry source, destination
 
-        replace_static(File.join('script', 'server'), "API-#{resource}")
-        replace_static(File.join('api', 'base.rb'), ":#{prefix}")
-        replace_static(File.join('spec', 'requests', 'root_spec.rb'), prefix)
-        replace_static(File.join('spec', 'requests', 'documentation_spec.rb'), prefix)
+        config_static.each do |config|
+          replace_static(File.join(config[:file]), config[:pattern])
+        end
 
         Orms.build(destination, options[:orm]) if options[:orm]
+        Starter::Config.save(content: { prefix: prefix })
+
         self
       end
 
+      def config_static
+        [
+          { file: %w[script server], pattern: "API-#{resource}" },
+          { file: %w[api base.rb], pattern: prefix ? "prefix :#{prefix}" : nil },
+          { file: %w[spec requests root_spec.rb], pattern: prefix ? "/#{prefix}" : nil },
+          { file: %w[spec requests documentation_spec.rb], pattern: prefix ? "/#{prefix}" : nil }
+        ]
+      end
+
       # would be called from add command
       #
       # resource - A String as name
@@ -99,7 +109,7 @@ module Starter
       def replace_static(file, replacement)
         server_file = File.join(destination, file)
 
-        FileFoo.call!(server_file) { |content| content.gsub!('{{{grape-starter}}}', replacement) }
+        FileFoo.call!(server_file) { |content| content.gsub!('{{{grape-starter}}}', replacement.to_s) }
       end
 
       # #add! a new resource releated helper methods

data/lib/starter/builder/base_file.rb

@@ -27,8 +27,9 @@ module Starter
     # parses out the prefix from base api file
     def base_prefix
       base_file
-
-      base_file.scan(/prefix\s+(:.+)\n/).first.first.delete!(':')
+      scan = base_file.scan(/prefix\s+(:.+)\n/)
+      scan.first.first.delete!(':') unless scan.empty?
+      # Starter::Config.read[:prefix]
     end
 
     # parses out the version from base api file

data/lib/starter/builder/names.rb

@@ -15,6 +15,10 @@ module Starter
         require 'starter/builder/templates/sequel'
         extend(::Starter::Templates::Sequel)
         "#{klass_name} < #{model_klass}"
+      when 'activerecord', 'ar'
+        require 'starter/builder/templates/activerecord'
+        extend(::Starter::Templates::ActiveRecord)
+        "#{klass_name} < #{model_klass}"
       else
         klass_name
       end

data/lib/starter/builder/orms.rb

@@ -4,10 +4,15 @@ module Starter
   class Orms
     class << self
       def build(dest, orm)
-        case orm
+        case orm.downcase
         when 'sequel'
           require 'starter/builder/templates/sequel'
           extend(::Starter::Templates::Sequel)
+        when 'activerecord', 'ar'
+          require 'starter/builder/templates/activerecord'
+          extend(::Starter::Templates::ActiveRecord)
+          # Fixes pooling
+          add_middleware(dest, 'ActiveRecord::Rack::ConnectionManagement')
         else
           return
         end
@@ -17,7 +22,7 @@ module Starter
         append_to_file(File.join(dest, 'Rakefile'), rakefile)
         append_to_file(File.join(dest, 'Gemfile'), gemfile)
         prepare_for_migrations(File.join(dest, 'db'))
-        Starter::Config.save(dest: dest, content: { orm: orm })
+        Starter::Config.save(dest: dest, content: { orm: orm.downcase })
       end
 
       private
@@ -31,6 +36,12 @@ module Starter
         FileFoo.write_file(File.join(dest, 'database.yml'), config)
       end
 
+      # adds a middleware to config.ru
+      def add_middleware(dest, middleware)
+        replacement = "use #{middleware}\n\n\\1"
+        FileFoo.call!(File.join(dest, 'config.ru')) { |content| content.sub!(/^(run.+)$/, replacement) }
+      end
+
       def append_to_file(file_name, content)
         original = FileFoo.read_file(file_name)
         FileFoo.write_file(file_name, "#{original}\n\n#{content}")

data/lib/starter/builder/templates/activerecord.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+module Starter
+  module Templates
+    module ActiveRecord
+      def model_klass
+        'ActiveRecord::Base'
+      end
+
+      def initializer
+        <<-FILE.strip_heredoc
+        require 'yaml'
+        require 'erb'
+        require 'active_record'
+
+        config_content = File.read(File.join('config', 'database.yml'))
+
+        db_conf = YAML.safe_load(ERB.new(config_content).result)
+        env = ENV['RACK_ENV'] || 'development'
+
+        ActiveRecord::Base.establish_connection db_conf[env]
+        logger = if %w[development test].include? env
+          log_dir = File.join(Dir.getwd, 'log')
+          log_file = File.join(log_dir, 'db.log')
+          FileUtils.mkdir(log_dir) unless Dir.exist?(log_dir)
+          Logger.new(File.open(log_file, 'a'))
+        else
+          Logger.new(STDOUT)
+        end
+
+        ActiveRecord::Base.logger = logger
+
+        # Middleware
+        module ActiveRecord
+          module Rack
+            # ActiveRecord >= 5 removes the Pool management
+            class ConnectionManagement
+              def initialize(app)
+                @app = app
+              end
+
+              def call(env)
+                response = @app.call(env)
+                response[2] = ::Rack::BodyProxy.new(response[2]) do
+                  ActiveRecord::Base.clear_active_connections!
+                end
+
+                return response
+              rescue Exception
+                ActiveRecord::Base.clear_active_connections!
+                raise
+              end
+            end
+          end
+        end
+        FILE
+      end
+
+      def config # TODO: Dry (Same config for Sequel)
+        <<-FILE.strip_heredoc
+        # ActiveRecord Database Configuration
+        development:
+          adapter: 'sqlite3'
+          host: localhost
+          port: 27017
+          database: "db/development.sqlite3"
+          username:
+          password:
+
+        test:
+          adapter: 'sqlite3'
+          host: localhost
+          port: 27017
+          database: "db/test.sqlite3"
+          username:
+          password:
+
+        production:
+          adapter: 'sqlite3'
+          host: localhost
+          port: 27017
+          database: "db/production.sqlite3"
+          username:
+          password:
+        FILE
+      end
+
+      def rakefile
+        <<-FILE.strip_heredoc
+        # ActiveRecord DB tasks
+
+        task :load_config do
+          config_dir = File.expand_path('../config', __FILE__)
+          config_content = File.read(File.join(config_dir, 'database.yml'))
+
+          DatabaseTasks.env = ENV['RACK_ENV'] || 'development'
+          DatabaseTasks.db_dir = db_dir
+          config = YAML.safe_load(ERB.new(config_content).result)
+          DatabaseTasks.database_configuration = config
+          DatabaseTasks.migrations_paths = File.join(db_dir, 'migrate')
+
+          ActiveRecord::Base.configurations = DatabaseTasks.database_configuration
+          ActiveRecord::Base.establish_connection DatabaseTasks.env.to_sym
+        end
+
+        # Loads AR tasks like db:create, db:drop etc..
+        load 'active_record/railties/databases.rake'
+        FILE
+      end
+
+      def gemfile
+        <<-FILE.strip_heredoc
+        # DB stack
+        gem 'activerecord', '~> 5.1'
+        gem 'sqlite3'
+        FILE
+      end
+    end
+  end
+end

data/lib/starter/builder/templates/files.rb

@@ -48,12 +48,13 @@ module Starter
       end
 
       def api_spec
+        prefix = base_prefix ? "/#{base_prefix}" : ''
         <<-FILE.strip_heredoc
         # frozen_string_literal: true
 
         require 'spec_helper'
 
-        RSpec.describe '/#{base_prefix}/#{base_version}/#{resource.downcase}' do
+        RSpec.describe '#{prefix}/#{base_version}/#{resource.downcase}' do
           #{endpoint_specs}
         end
         FILE

data/lib/starter/config.rb

@@ -10,7 +10,8 @@ module Starter
       end
 
       def save(dest: Dir.getwd, content: nil)
-        return if content.nil? || content.empty?
+        return if content.nil? || content.empty? || !content.is_a?(Hash)
+        content = read.merge(content)
         File.open(File.join(dest, '.config'), 'w') { |f| f.write(YAML.dump(content)) }
       end
     end

data/lib/starter/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Starter
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

data/template/api/base.rb

@@ -2,9 +2,7 @@
 
 module Api
   class Base < Grape::API
-    # !!! a prefix is always required
-    # would be set after project name, to provide a namespace
-    prefix {{{grape-starter}}}
+    {{{grape-starter}}}
     version 'v1', using: :path
     format :json
 

data/template/config.ru

@@ -1,6 +1,7 @@
 # frozen_string_literal: false
 
 require 'rack/cors'
+require_relative 'config/application'
 
 use Rack::CommonLogger
 
@@ -11,6 +12,4 @@ use Rack::Cors do
   end
 end
 
-require File.expand_path('../config/application', __FILE__)
-
 run App.new

data/template/config/application.rb

@@ -16,6 +16,7 @@ class DocApp
   end
 
   def template
+    prefix = Api::Base.prefix ? "/#{Api::Base.prefix}" : ''
     "<!DOCTYPE html>
     <html>
       <head>
@@ -24,7 +25,7 @@ class DocApp
         <style>body {margin: 0;padding: 0;}</style>
       </head>
       <body>
-        <redoc spec-url='http://#{server}:#{port}/#{Api::Base.prefix}/#{Api::Base.version}/oapi.json'></redoc>
+        <redoc spec-url='http://#{server}:#{port}#{prefix}/#{Api::Base.version}/oapi.json'></redoc>
         <script src='https://rebilly.github.io/ReDoc/releases/latest/redoc.min.js'> </script>
       </body>
     </html>"

data/template/spec/requests/documentation_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe '/{{{grape-starter}}}/v1/oapi' do
+RSpec.describe '{{{grape-starter}}}/v1/oapi' do
   subject(:swagger) do
     get RSpec.current_example.metadata[:example_group][:full_description]
     last_response

data/template/spec/requests/root_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-RSpec.describe '/{{{grape-starter}}}/v1/root' do
+RSpec.describe '{{{grape-starter}}}/v1/root' do
   let(:exposed_keys) do
     %i[
       verb

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-05-26 00:00:00.000000000 Z
+date: 2017-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -93,6 +93,7 @@ files:
 - lib/starter/builder/file_foo.rb
 - lib/starter/builder/names.rb
 - lib/starter/builder/orms.rb
+- lib/starter/builder/templates/activerecord.rb
 - lib/starter/builder/templates/endpoints.rb
 - lib/starter/builder/templates/files.rb
 - lib/starter/builder/templates/sequel.rb
@@ -148,7 +149,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.11
+rubygems_version: 2.6.12
 signing_key: 
 specification_version: 4
 summary: Create a Grape Rack skeleton