grape-starter 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 52f430416f92875210e64914e6fe61c29d4c3e56
+  data.tar.gz: 77f33daa8ca7ef7f49e4415acaf2261edc888969
+SHA512:
+  metadata.gz: 94908b48037df0376311ddb26b61e408e99b9fd65e017fbb484a121cdaacea7fc65fe12fc7eae1930ba5239becefddf5555ecca2d02599ec9b05cafe570ae48a
+  data.tar.gz: f089a230198355841150ae7353973e0fc8180c50e2e742f98ed63363c193b48ac199f46694238e2a516ebd0ce970028e876bcae079f97962820c500962919b90

data/.gitignore

@@ -0,0 +1,12 @@
+.DS_Store
+.rvmrc
+.redcar
+.irbrc
+.bundle
+log
+Gemfile.lock
+docker-compose.yml
+Dockerfile
+tmp/
+.rspec
+pkg/

data/.rubocop.yml

@@ -0,0 +1,36 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  Exclude:
+    - '**/bin/**/*'
+    - '**/tmp/**/*'
+    - '**/script/**/*'
+    - grape-starter.gemspec
+  UseCache: true
+  TargetRubyVersion: 2.3
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'
+
+Metrics/LineLength:
+  Max: 120
+
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/starter/builder/template_files.rb'
+    - 'lib/starter/builder/template_endpoints.rb'
+
+Style/AsciiComments:
+  Enabled: false
+
+Style/IndentationWidth:
+  Exclude:
+    - 'lib/starter/builder/template_files.rb'
+    - 'lib/starter/builder/template_endpoints.rb'
+
+Style/Documentation:
+  Exclude:
+    - 'template/**/*'
+    - 'lib/**/*'
+    - 'spec/**/*'

data/.rubocop_todo.yml

@@ -0,0 +1,12 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2016-10-18 20:40:59 +0200 using RuboCop version 0.44.1.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Max: 13

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+
+language: ruby
+rvm:
+  - 2.3.2

data/CHANGELOG.md

@@ -0,0 +1,27 @@
+### 0.1.8
+
+- adds request specs shared examples
+
+### 0.1.7
+
+- corrects path param for specific endpoints
+
+### 0.1.6
+
+- corrects adding of endpoints, if no http verb was given
+
+### 0.1.5
+
+- adds flag for entity creating
+
+### 0.1.4
+
+- version bump v0.1.4
+- moves back dependencies to gemspec
+- adds rubygems badge
+- cleans up dependencies  …
+- updates readme
+- version bump v0.1.2
+- adds `force` option to add
+- version bump v0.1.1
+- adds specifying http verbs

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+source 'http://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Peter Scholz
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+[![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)
+[![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)
+
+# Grape Starter
+
+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.
+
+
+## Usage
+
+#### Install it
+```
+$ gem install grape-starter
+```
+
+#### Create a new project
+```
+$ grape-starter new awesome_api
+```
+
+This command creates a folder named `awesome_api` containing the skeleton. With following structure:
+
+```
+├── <Standards>
+├── api
+│   ├── base.rb        # the main API class, all other endpoints would be mounted in it
+│   ├── endpoints      # contains the endpoint file for a resource
+│   │   └── root.rb    # root is always available, it exposes all routes/endpoints, disable by comment out in base.rb
+│   └── entities       # contains the entity representation of the reource, if wanted
+│       └── route.rb
+├── config             # base configuration
+│   └── …
+├── config.ru          # Rack it up
+├── lib                # contains the additional lib file for a resource
+│   ├── api
+│   │   └── version.rb
+│   └── api.rb
+├── script             # setup / server / test etc.
+│   └── …
+└── spec               # RSpec
+    └── …
+```
+
+To run it, go into awesome_api folder, start the server
+```
+$ cd awesome_api
+$ ./script/server
+```
+the API is now accessible under: [http://localhost:9292/api/v1/root](http://localhost:9292/api/v1/root)
+
+More could be found in [README](template/README.md).
+
+#### Add resources
+```
+$ grape-starter add foo
+```
+to add CRUD endpoints for resource foo. For more options, see command help.
+
+This adds endpoint and lib file and belonging specs, and a mount entry in base.rb.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/LeFnord/grape-starter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](LICENSE).

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+require 'bundler/gem_tasks'
+
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+RuboCop::RakeTask.new(:rubocop)
+
+task default: [:rubocop, :spec]

data/bin/grape-starter

@@ -0,0 +1,119 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+
+require 'pry'
+require 'gli'
+require 'starter'
+
+include GLI::App
+
+program_desc 'Create initial grape api skeleton'
+
+version Starter::VERSION
+
+subcommand_option_handling :normal
+arguments :strict
+
+desc 'overwrites existend stuff'
+switch [:f, :force], negatable: false
+
+desc 'Create initial grape api skeleton'
+arg_name 'project name'
+
+command :new do |c|
+
+  c.action do |global_options, _, args|
+    dir = 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]
+      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
+      # TODO:
+      $stdout.puts `bundle install`
+      $stdout.puts `bundle exec rubocop -a`
+      $stdout.puts `git init`
+    end
+  end
+end
+
+desc 'Adds a new resource - run from inside the project'
+long_desc "run this command from inside the project
+hereby the the given resource name
+can be given in form of
+'foo(s)', 'foo_bar(s)''"
+arg_name 'resource [post* get* put* patch* delete*]'
+command :add do |c|
+  c.desc 'adds entity file'
+  c.switch [:e, :entity], negatable: false
+
+  c.action do |global_options, options, args|
+    exit_now! 'no resource given' if args.empty?
+
+    resource = args.shift
+    set = args
+
+    begin
+      builder_options = global_options.merge(set: set).merge(options)
+      Starter::Builder.call!(resource, builder_options)
+      created_files = Starter::Builder.save
+
+      `bundle exec rubocop -a #{created_files.join(' ')}`
+      $stdout.puts "added resource: #{resource}"
+    rescue => e
+      exit_now! e
+    end
+  end
+end
+
+desc 'Removes a resource - run from inside the project'
+arg_name 'resource'
+command :remove do |c|
+  # c.desc 'adds entity file'
+  # c.switch [:e, :entity], negatable: false
+
+  c.action do |global_options, options, args|
+    exit_now! 'no resource given' if args.empty?
+    resource = args.first
+
+    Starter::Builder.remove!(resource)
+
+    $stdout.puts "removed resource: #{resource}"
+  end
+end
+
+
+pre do |_global, _command, _options, _args|
+  # Pre logic here
+  # Return true to proceed; false to abort and not call the
+  # chosen command
+  # Use skips_pre before a command to skip this block
+  # on that command only
+  true
+end
+
+post do |global, command, options, args|
+  # Post logic here
+  # Use skips_post before a command to skip this
+  # block on that command only
+end
+
+on_error do |_exception|
+  # Error logic here
+  # return false to skip default error handling
+  true
+end
+
+exit run(ARGV)

data/grape-starter.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+# frozen_string_literal: true
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'starter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'grape-starter'
+  spec.version       = Starter::VERSION
+  spec.authors       = ['LeFnord']
+  spec.email         = ['pscholz.le@gmail.com']
+
+  spec.summary       = 'Create a Grape Rack skeleton'
+  spec.description   = 'CLI to create a API skeleton based on Grape and Rack'
+  spec.homepage      = 'https://github.com/LeFnord/grape-starter'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'gli', '~> 2.14'
+  spec.add_dependency 'activesupport', '~> 5.0'
+  spec.add_dependency 'rubocop', '~> 0.40'
+
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'grape', '~> 0.18'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rack-test'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'awesome_print'
+
+end

data/lib/starter.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+require 'awesome_print'
+
+require 'starter/version'
+require 'starter/builder'
+
+module Starter
+  autoload :Rake, 'starter/rake/grape_tasks'
+end

data/lib/starter/builder.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+require 'active_support/core_ext/string'
+
+module Starter
+  require 'starter/builder/names'
+  require 'starter/builder/template_files'
+  require 'starter/builder/template_endpoints'
+
+  class Builder
+    extend Starter::Names
+    extend Template::Files
+    extend Template::Endpoints
+
+    class << self
+      attr_reader :resource, :set, :force, :entity
+
+      def call!(resource, options = {})
+        @resource = resource
+        @set = options[:set]
+        @force = options[:force]
+        @entity = options[:entity]
+
+        self
+      end
+
+      def remove!(resource)
+        @resource = resource
+
+        files_to_remove = file_list.map { |x| send("#{x}_name") }
+        FileUtils.rm files_to_remove
+      end
+
+      def save
+        file_list.each do |new_file|
+          save_file(new_file)
+        end
+
+        add_moint_point
+
+        file_list.map { |x| send("#{x}_name") }
+      end
+
+      def endpoints
+        content(endpoint_set).join("\n\n")
+      end
+
+      def endpoint_specs
+        content(endpoint_set.map { |x| "#{x}_spec" }).join("\n")
+      end
+
+      private
+
+      def file_list
+        standards = %w(api_file lib_file api_spec lib_spec)
+
+        entity ? standards + ['entity_file'] : standards
+      end
+
+      def save_file(new_file)
+        new_file_name = "#{new_file}_name"
+        should_raise?(send(new_file_name))
+
+        File.open(send(new_file_name), 'w+') { |file| file.write(send(new_file.strip_heredoc)) }
+      end
+
+      def should_raise?(file)
+        raise StandardError, '… resource exists' if File.exist?(file) && !force
+      end
+
+      def add_moint_point
+        file = File.read(api_base_file_name)
+        occurence = file.scan(/(\s+mount.*?\n)/).last.first
+        replacement = occurence + "    mount Endpoints::#{klass_name}\n"
+        file.sub!(occurence, replacement)
+        File.open(api_base_file_name, 'w') { |f| f.write(file) }
+      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
+
+      def content(set)
+        set.map { |x| send(x) }
+      end
+    end
+  end
+end