grape-starter 0.8.7 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dfa9a76e1ab4ba6bce2e9aa5a845d3badb99b90446fbb9aa2714dae5449901d
-  data.tar.gz: 73814dbd39bc08faba9b3ba4a21ac90aeef3b099e9294359c6ce805fe438b610
+  metadata.gz: e073b45cc89020c1371c9d38206265d3bdf4087316dfc12988394663eb10f935
+  data.tar.gz: 1446043c5698906fac0f89342f73a27dfbc7e252d2ac1a121be61ae0d25599a2
 SHA512:
-  metadata.gz: 13a86d442ec14d2bbe639b2847b99d2b0a064e23dbb6992c7a76715dbfa405bac1ea6253e1b548ea3e40c6ce6189bc075a58af469e3540b295f777465b63dd1e
-  data.tar.gz: 8030e723fec17634d51d8c52ad917cee13936224f8855822ce0d264226c78d19083bf002e240374ad4cedb6a7c1e67ca674ceb42e6c9c6cd773f17b996e0c529
+  metadata.gz: c42f38b0c69e3661b655802276ba280b5c104e289d86ab100fbba572692dd11fe9d558f5cec35927b9fc8617ca8c876fdc26abaaad609aaed86521bb7941fa37
+  data.tar.gz: d894032459bf6daf5ea08386313944251f77cfca81d18b7b9fbd4347db0f7f750294fa5e6d6fcaceccd22d3f273753c9c483be5a9290a10826b5ad237a6a74e1

data/.gitignore

@@ -8,7 +8,6 @@ Gemfile.lock
 docker-compose.yml
 Dockerfile
 tmp/
-.rspec
 pkg/
 template/Gemfile.lock
 grape-starter.md

data/.rspec

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

data/.travis.yml

@@ -7,11 +7,16 @@ before_install:
   - gem install bundler
 
 rvm:
-  - 2.5.0
-  - 2.4.3
-  - ruby-head
+  - 2.5.1
+  - 2.4.4
 
 matrix:
   fast_finish: true
+
+  include:
+    - rvm: ruby-head
+    - rvm: 2.3.7
+
   allow_failures:
     - rvm: ruby-head
+    - rvm: 2.3.7

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 - contributions
 
+### 1.0.0
+
+- [67a5f](https://github.com/LeFnord/grape-starter/commit/b1f32801844ed9a98bc4d5f7c938451ef7667a5f) - supports creating a migration file
+- [de26b](https://github.com/LeFnord/grape-starter/commit/22ad2170176b9602cff2239a7d0469c823cde26b) - ci adoptions
+- [7ad69](https://github.com/LeFnord/grape-starter/commit/925fa5fb161c8cc26c96834e185d8299a207ad69) - spec improvements
+
 ### 0.8.7
 
 - [c7cb2](https://github.com/LeFnord/grape-starter/commit/4be5bd9b7c06611e096d6eaa23d7168136bc7cb2) - updates dependencies; makes rubocop happy

data/Gemfile

@@ -5,11 +5,12 @@ source 'http://rubygems.org'
 gemspec
 
 group :development, :test do
-  gem 'grape', '>= 0.19.1'
+  gem 'grape', '~> 1.0'
   gem 'pry', platforms: [:mri]
   gem 'pry-byebug', platforms: [:mri]
   gem 'rack-cors', require: false
   gem 'rack-test', require: false
-  gem 'rake', '>= 10.0'
-  gem 'rspec', '>= 3.0'
+  gem 'rake', '~> 12.0'
+  gem 'rspec', '~> 3.7'
+  gem 'rspec-command'
 end

data/README.md

@@ -97,8 +97,9 @@ This adds endpoint and lib file and belonging specs, and a mount entry in base.r
 
 Using it with following options:
 ```
--e, --entity # a grape entity file will also be created
--o, --orm    # sets the parent class of libe file (e.g: `Foo < Sequel::Model` for Sequel)
+-e, --entity    # a grape entity file will also be created
+-m, --migration # adds also a migration file, if an ORM is used
+-o, --orm       # sets the parent class of libe file (e.g: `Foo < Sequel::Model` for Sequel)
 ```
 to add CRUD endpoints for resource foo. By given http methods only this one would be generated.
 For available methods see: [`Templates::Endpoints`](https://github.com/LeFnord/grape-starter/blob/d7bb6c4946dc27fcafa5a75435b45bfe2b7277f0/lib/starter/builder/templates/endpoints.rb#L7-L26).

data/bin/grape-starter

@@ -61,6 +61,8 @@ command :add do |c|
            desc: 'adds entity file'
   c.switch [:o, :orm], negatable: false,
            desc: 'inherit from ORM'
+  c.switch [:m, :migration], negatable: false,
+           desc: 'create also migration file'
 
   c.action do |global_options, options, args|
     exit_now! 'no resource given' if args.empty?

data/lib/starter/builder.rb

@@ -27,6 +27,9 @@ module Starter
       # name - A String as project name
       # source - A String which provides the template path
       # destination - A String which provides the new project path
+      # options - A Hash to provide some optional arguments (default: {})
+      #   :prefix - Sets the Prefix for the API
+      #   :orm - Sets and creates ORM specific files
       def new!(name, source, destination, options = {})
         @resource = name
         @destination = destination
@@ -38,29 +41,25 @@ module Starter
           replace_static(File.join(config[:file]), config[:pattern])
         end
 
+        Starter::Config.save(
+          dest: destination,
+          content: { prefix: prefix, orm: options[:orm].to_s }
+        )
+
         Orms.build(destination, options[:orm]) if options[:orm]
-        Starter::Config.save(dest: destination, 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
       # 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: false)
-      #           :entity - A Boolean, if given an entity file would be created (default: false)
+      #   :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: false)
+      #   :entity - A Boolean, if given an entity file would be created (default: false)
+      #   :orm - A Boolean, if given the created lib/model file will be inherited orm specific (default: false)
       def add!(resource, options = {})
         @resource = resource
         @set = options[:set]
@@ -68,6 +67,7 @@ module Starter
         @entity = options[:entity]
         @orm = options[:orm]
 
+        Orms.add_migration(klass_name, resource.downcase) if @orm
         save_resource
       end
 
@@ -75,7 +75,7 @@ module Starter
       #
       # resource - A String, which indicates the resource to remove
       # options - A Hash to provide some optional arguments (default: {})
-      #           :entity - A Boolean, if given an entity file would also be removed (default: nil -> false)
+      #   :entity - A Boolean, if given an entity file would also be removed (default: nil -> false)
       def remove!(resource, options = {})
         @resource = resource
         @entity = options[:entity]
@@ -105,7 +105,18 @@ module Starter
 
       # #new! project creation releated helper methods
       #
-      # replace something in existend files
+      # defines static files to be created
+      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
+
+      #
+      # replace something in static files
       def replace_static(file, replacement)
         server_file = File.join(destination, file)
 

data/lib/starter/builder/orms.rb

@@ -4,18 +4,12 @@ module Starter
   class Orms
     class << self
       def build(dest, orm)
-        @orm = 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)
+        load_orm(orm: orm)
+        return if @orm.nil?
+
+        if @orm == 'ar' || @orm == 'activerecord'
           # Fixes pooling
           add_middleware(dest, 'ActiveRecord::Rack::ConnectionManagement')
-        else
-          return
         end
 
         build_initializer(File.join(dest, 'config', 'initializers'))
@@ -23,8 +17,6 @@ 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.downcase })
       end
 
       def config
@@ -56,6 +48,30 @@ module Starter
         FILE
       end
 
+      def add_migration(klass_name, resource)
+        load_orm
+        return if @orm.nil?
+
+        file_name = "#{Time.now.strftime('%Y%m%d%H%m%S')}_Create#{klass_name}.rb"
+        migration_dest = File.join(Dir.pwd, 'db', 'migrations', file_name)
+        FileFoo.write_file(migration_dest, migration(klass_name, resource))
+      end
+
+      def load_orm(orm: ::Starter::Config.read[:orm])
+        @orm = orm
+
+        case @orm
+        when 'sequel'
+          require 'starter/builder/templates/sequel'
+          extend(::Starter::Templates::Sequel)
+        when 'activerecord', 'ar'
+          require 'starter/builder/templates/activerecord'
+          extend(::Starter::Templates::ActiveRecord)
+        else
+          @orm = nil
+        end
+      end
+
       private
 
       def adapter

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

@@ -86,6 +86,19 @@ module Starter
         gem 'sqlite3'
         FILE
       end
+
+      def migration(klass_name, resource)
+        <<-FILE.strip_heredoc
+        class Create#{klass_name} < ActiveRecord::Migration[5.1]
+          def change
+            create_table :#{resource} do |t|
+
+              t.timestamps
+            end
+          end
+        end
+        FILE
+      end
     end
   end
 end

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

@@ -86,6 +86,21 @@ module Starter
         gem 'sqlite3'
         FILE
       end
+
+      def migration(_klass_name, resource)
+        <<-FILE.strip_heredoc
+        Sequel.migration do
+          change do
+            create_table :#{resource} do
+              primary_key :id
+
+              DateTime :created_at
+              DateTime :updated_at
+            end
+          end
+        end
+        FILE
+      end
     end
   end
 end

data/lib/starter/version.rb

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

data/template/Gemfile

@@ -7,7 +7,6 @@ gem 'thin'
 gem 'rack'
 gem 'rack-cors'
 
-# FIXME: lock to specific version before you are going into production
 gem 'grape'
 gem 'grape-entity'
 gem 'grape-swagger'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.8.7
+  version: 1.0.0
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-08 00:00:00.000000000 Z
+date: 2018-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -76,6 +76,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".inch.yml"
+- ".rspec"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
 - ".travis.yml"