grape-starter 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 567acba57f6b5bbef50e10c04ef3ed959d1d877b
-  data.tar.gz: 68dea7756db9323789392a89435adc899aab2c72
+  metadata.gz: ac704eaf32a74db38f046a62b8a949ccd89ef03c
+  data.tar.gz: f19c5ac175f20052670b27c09d9e9449e0f8e6c7
 SHA512:
-  metadata.gz: 50e159bda1bd6411ca34f4ee63269fc6ae403e068e51b64926d29f50d5ba0badbc87d744d5fc1867ffd5fe46a894767d84523e3d6287f2a78a6de794dbbe26ba
-  data.tar.gz: 1065e7cc75744049be7df78c5a2ec275a3786596e37cf6486301bdc3d94b8ff1a4736650bf407f254afc87dabe3d67920b491ed2adcf866e0510b1bf81fbc028
+  metadata.gz: bc576028aa7419e171a7da9ec02d36527e067a3afeae583547f795bb4fcd61cb3e2f9f27be1591c9e46c4d8b4f1b3bc71a59f43498098337b6d732ebccb52e42
+  data.tar.gz: '0950501ead93312c1ba389c5f33c675500b98fe3a35232b0ae8ab65d8b7efabe7dc5fcba8e233cd8a00d0e9c812262d4cb6b49d5fe5ab5762bf1441c386d3deb'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ### NEXT
 
+### 0.5.0
+
+- simplyfies request specs, **breaking change**: takes route from spec description
+- adds option to set prefix, defaults to api
+- sets prefix after project name
+
 ### 0.4.2
 
 - sets prefix after project name

data/README.md

@@ -91,6 +91,3 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/LeFnor
 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

@@ -22,7 +22,11 @@ switch [:f, :force], negatable: false
 desc 'Creates initial api skeleton'
 arg_name 'awesome_api'
 command :new do |c|
-  c.action do |global_options, _, args|
+  c.flag [:p, :prefix],
+         default_value: 'api',
+         desc: 'sets the prefix of the API (default: api, given: takes this)'
+
+  c.action do |global_options, options, args|
     dest = args.empty? ? nil : File.join(Dir.getwd, args.first)
 
     case
@@ -34,7 +38,7 @@ command :new do |c|
       starter_gem = Gem::Specification.find_by_name('grape-starter').gem_dir
       src = File.join(starter_gem, 'template', '.')
 
-      Starter::Builder.new!(args.first, src, dest)
+      Starter::Builder.new!(args.first, src, dest, options[:p])
       $stdout.puts "created: #{args.first}"
 
       # after creating tasks
@@ -63,8 +67,7 @@ command :add do |c|
 
     begin
       builder_options = global_options.merge(set: set).merge(options)
-      Starter::Builder.add!(resource, builder_options)
-      created_files = Starter::Builder.save
+      created_files = Starter::Builder.add!(resource, builder_options)
 
       `bundle exec rubocop -a #{created_files.join(' ')}`
       $stdout.puts "added resource: #{resource}"

data/lib/starter/builder.rb

@@ -3,30 +3,39 @@ require 'active_support/core_ext/string'
 
 module Starter
   require 'starter/builder/names'
+  require 'starter/builder/base_file'
+  require 'starter/builder/file_foo'
   require 'starter/builder/template_files'
   require 'starter/builder/template_endpoints'
 
   class Builder
     extend Starter::Names
+    extend Starter::BaseFile
     extend Template::Files
     extend Template::Endpoints
 
     class << self
-      attr_reader :resource, :set, :force, :entity, :destination
-
+      attr_reader :prefix, :resource, :set, :force, :entity, :destination
+      #
+      # public methods
+      #
+      #
       # would be called from new command
       #
       # 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)
+      def new!(name, source, destination, prefix = 'api')
+        @prefix = prefix
         @resource = name
         @destination = destination
 
         FileUtils.copy_entry source, destination
 
         replace_static(File.join('script', 'server'), "API-#{resource}")
-        replace_static(File.join('api', 'base.rb'), ":#{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)
 
         self
       end
@@ -45,23 +54,10 @@ module Starter
         @force = options[:force]
         @entity = options[:entity]
 
-        self
-      end
-
-      #
-      # … it saves the files
-      def save
-        created_files = file_list.each_with_object([]) do |new_file, memo|
-          memo << send("#{new_file}_name")
-          save_file(new_file)
-        end
-
-        add_mount_point
-
-        created_files
+        save_resource
       end
 
-      # would be called on from command
+      # would be called on from rm command
       #
       # resource - A String, which indicates the resource to remove
       # options - A Hash to provide some optional arguments (default: {})
@@ -93,13 +89,17 @@ module Starter
 
       private
 
-      # get content for and save new resource files
-      def save_file(new_file)
-        new_file_name = "#{new_file}_name"
-        should_raise?(send(new_file_name))
-        write_file(send(new_file_name), send(new_file.strip_heredoc))
+      # #new! project creation releated helper methods
+      #
+      # replace something in existend files
+      def replace_static(file, replacement)
+        server_file = File.join(destination, file)
+
+        FileFoo.call!(server_file) { |content| content.gsub!('{{{grape-starter}}}', replacement) }
       end
 
+      # #add! a new resource releated helper methods
+      #
       # provides an array of endpoints for the new resource
       def endpoint_set
         crud_set = singular? ? singular_one : crud
@@ -108,76 +108,46 @@ module Starter
         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)
+      #
+      # saves all resource related files the files
+      def save_resource
+        created_files = file_list.each_with_object([]) do |new_file, memo|
+          memo << send("#{new_file}_name")
+          save_file(new_file)
+        end
 
-        entity ? standards + ['entity_file'] : standards
-      end
+        add_mount_point
 
-      # raises if resource exist and force false
-      def should_raise?(file)
-        raise StandardError, '… resource exists' if File.exist?(file) && !force
+        created_files
       end
 
-      # replace something in exitend files
-      #
-      # will be called on project creation
       #
-      # … static files such as under script folder,
-      def replace_static(file, replacement)
-        server_file = File.join(destination, file)
-
-        file_foo(server_file) { |content| content.gsub!('{{{grape-starter}}}', replacement) }
+      # saves new resource files
+      def save_file(new_file)
+        new_file_name = "#{new_file}_name"
+        should_raise?(send(new_file_name))
+        FileFoo.write_file(send(new_file_name), send(new_file.strip_heredoc))
       end
 
-      # will be called an resource creation
       #
-      # … add it in api base
-      def add_mount_point
-        file_foo(api_base_file_name) { |content| add_to_base(content) }
-      end
-
-      # … adding
-      def add_to_base(file)
-        occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
-        replacement = occurence + mount_point
-        file.sub!(occurence, replacement)
+      # raises if resource exist and force false
+      def should_raise?(file)
+        raise StandardError, '… resource exists' if File.exist?(file) && !force
       end
 
-      # … remove it in api base
-      def remove_mount_point
-        file_foo(api_base_file_name) { |content| remove_from_base(content) }
-      end
+      # #add! and #remove! a new resource releated helper methods
+      #
+      # provides a file list for the new resource
+      def file_list
+        standards = %w(api_file lib_file api_spec lib_spec)
 
-      # … removing
-      def remove_from_base(file)
-        file.sub!(mount_point, '')
+        entity ? standards + ['entity_file'] : standards
       end
 
       # content of the given set of files,
       def content(set)
         set.map { |x| send(x) }
       end
-
-      # general file stuff
-      #
-      # … reading and writing content
-      def file_foo(file)
-        content = read_file(file)
-        yield content
-        write_file(file, content)
-      end
-
-      # … read
-      def read_file(file)
-        File.read(file)
-      end
-
-      # … write
-      def write_file(file, content)
-        File.open(file, 'w') { |f| f.write(content) }
-      end
     end
   end
 end

data/lib/starter/builder/base_file.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+module Starter
+  module BaseFile
+    # add it in api base
+    def add_mount_point
+      FileFoo.call!(api_base_file_name) { |content| add_to_base(content) }
+    end
+
+    # adding mount point to base class
+    def add_to_base(file)
+      occurence = file.scan(/(\s+mount\s.*?\n)/).last.first
+      replacement = occurence + mount_point
+      file.sub!(occurence, replacement)
+    end
+
+    # removes in api base
+    def remove_mount_point
+      FileFoo.call!(api_base_file_name) { |content| remove_from_base(content) }
+    end
+
+    # removes mount point form base class
+    def remove_from_base(file)
+      file.sub!(mount_point, '')
+    end
+
+    def base_prefix
+      base_file
+
+      base_file.scan(/prefix\s+(:.+)\n/).first.first.delete!(':')
+    end
+
+    def base_version
+      base_file
+
+      base_file.scan(/version\s+(.+),/).first.first.delete!("'")
+    end
+
+    def base_file
+      file = File.join(Dir.getwd, 'api', 'base.rb')
+      FileFoo.read_file(file)
+    end
+  end
+end

data/lib/starter/builder/file_foo.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+module Starter
+  class FileFoo
+    class << self
+      # general file stuff
+      #
+      # … reading and writing content
+      def call!(file)
+        content = read_file(file)
+        yield content
+        write_file(file, content)
+      end
+
+      # … read
+      def read_file(file)
+        File.read(file)
+      end
+
+      # … write
+      def write_file(file, content)
+        File.open(file, 'w') { |f| f.write(content) }
+      end
+    end
+  end
+end

data/lib/starter/builder/template_endpoints.rb

@@ -74,34 +74,34 @@ module Starter
       # request specs shared examples
       #
       def post_spec
-        "it_behaves_like 'POST', base_path: '/api/v1', resource: '#{resource}', params: {}"
+        "it_behaves_like 'POST', params: {}"
       end
 
       def get_all_spec
-        "it_behaves_like 'GET all', base_path: '/api/v1', resource: '#{resource}'"
+        "it_behaves_like 'GET all'"
       end
 
       %w(get delete).each do |verb|
         define_method(:"#{verb}_one_spec") do
-          "it_behaves_like '#{verb.upcase} one', base_path: '/api/v1', resource: '#{resource}'"
+          "it_behaves_like '#{verb.upcase} one'"
         end
       end
 
       %w(put patch).each do |verb|
         define_method(:"#{verb}_one_spec") do
-          "it_behaves_like '#{verb.upcase} one', base_path: '/api/v1', resource: '#{resource}', params: {}"
+          "it_behaves_like '#{verb.upcase} one', params: {}"
         end
       end
 
       %w(get delete).each do |verb|
         define_method(:"#{verb}_specific_spec") do
-          "it_behaves_like '#{verb.upcase} specific', base_path: '/api/v1', resource: '#{resource}', key: 1"
+          "it_behaves_like '#{verb.upcase} specific', key: 1"
         end
       end
 
       %w(put patch).each do |verb|
         define_method(:"#{verb}_specific_spec") do
-          "it_behaves_like '#{verb.upcase} specific', base_path: '/api/v1', resource: '#{resource}', key: 1, params: {}"
+          "it_behaves_like '#{verb.upcase} specific', key: 1, params: {}"
         end
       end
     end

data/lib/starter/builder/template_files.rb

@@ -51,7 +51,7 @@ module Starter
         # frozen_string_literal: true
         require 'spec_helper'
 
-        RSpec.describe Api::#{klass_name} do
+        RSpec.describe '/#{base_prefix}/#{base_version}/#{resource}' do
           #{endpoint_specs}
         end
         FILE

data/lib/starter/rspec/request_specs.rb

@@ -1,13 +1,18 @@
 # frozen_string_literal: true
-RSpec.shared_examples 'POST' do |base_path: '/api/v1', resource: '', params: {}|
-  let(:route) { "#{base_path}/#{resource}" }
+
+def route_from_description
+  RSpec.current_example.metadata[:example_group][:parent_example_group][:description_args].first
+end
+
+RSpec.shared_examples 'POST' do |params: {}|
+  let(:route) { route_from_description }
 
   subject { post route, params }
   specify { expect(subject.status).to eql 201 }
 end
 
-RSpec.shared_examples 'GET all' do |base_path: '/api/v1', resource: ''|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'GET all' do
+  let(:route) { route_from_description }
 
   subject { get route }
   specify { expect(subject.status).to eql 200 }
@@ -15,29 +20,29 @@ end
 
 # singular forms
 #
-RSpec.shared_examples 'GET one' do |base_path: '/api/v1', resource: ''|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'GET one' do
+  let(:route) { route_from_description }
 
   subject { get route }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'PUT one' do |base_path: '/api/v1', resource: '', params: {}|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'PUT one' do |params: {}|
+  let(:route) { route_from_description }
 
   subject { put route, params }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'PATCH one' do |base_path: '/api/v1', resource: '', params: {}|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'PATCH one' do |params: {}|
+  let(:route) { route_from_description }
 
   subject { patch route, params }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'DELETE one' do |base_path: '/api/v1', resource: ''|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'DELETE one' do
+  let(:route) { route_from_description }
 
   subject { delete route }
   specify { expect(subject.status).to eql 204 }
@@ -45,32 +50,32 @@ end
 
 # plural forms
 #
-RSpec.shared_examples 'GET specific' do |base_path: '/api/v1', resource: '', key: nil|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'GET specific' do |key: nil|
+  let(:route) { route_from_description }
   let(:specific_route) { "#{route}/#{key}" }
 
   subject { get specific_route }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'PUT specific' do |base_path: '/api/v1', resource: '', key: nil, params: {}|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'PUT specific' do |key: nil, params: {}|
+  let(:route) { route_from_description }
   let(:specific_route) { "#{route}/#{key}" }
 
   subject { put specific_route, params }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'PATCH specific' do |base_path: '/api/v1', resource: '', key: nil, params: {}|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'PATCH specific' do |key: nil, params: {}|
+  let(:route) { route_from_description }
   let(:specific_route) { "#{route}/#{key}" }
 
   subject { patch specific_route, params }
   specify { expect(subject.status).to eql 200 }
 end
 
-RSpec.shared_examples 'DELETE specific' do |base_path: '/api/v1', resource: '', key: nil|
-  let(:route) { "#{base_path}/#{resource}" }
+RSpec.shared_examples 'DELETE specific' do |key: nil|
+  let(:route) { route_from_description }
   let(:specific_route) { "#{route}/#{key}" }
 
   subject { delete specific_route }

data/lib/starter/version.rb

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

data/template/spec/requests/documentation_spec.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Api::Base do
+RSpec.describe '/{{{grape-starter}}}/v1/oapi' do
   subject(:swagger) do
-    get '/api/v1/oapi'
+    get RSpec.current_example.metadata[:example_group][:full_description]
     last_response
   end
 

data/template/spec/requests/root_spec.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 require 'spec_helper'
 
-RSpec.describe Api::Base do
+RSpec.describe '/{{{grape-starter}}}/v1/root' do
   let(:exposed_keys) do
     [
       :verb,
@@ -10,7 +10,7 @@ RSpec.describe Api::Base do
     ]
   end
 
-  subject { get '/api/v1/root' }
+  subject { get RSpec.current_example.metadata[:example_group][:full_description] }
   specify { expect(subject.status).to eql 200 }
 
   let(:response) { JSON.parse(subject.body, symbolize_names: true) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: grape-starter
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - LeFnord
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2016-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gli
@@ -160,6 +160,8 @@ files:
 - grape-starter.gemspec
 - lib/starter.rb
 - lib/starter/builder.rb
+- lib/starter/builder/base_file.rb
+- lib/starter/builder/file_foo.rb
 - lib/starter/builder/names.rb
 - lib/starter/builder/template_endpoints.rb
 - lib/starter/builder/template_files.rb