graphiti 1.0.alpha.5 → 1.0.alpha.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a97ae8d131e23bc5acf8f8a4fcb97e7cdce25fdc
-  data.tar.gz: 04ae2c8cc7d56ffea5dc0f8a3fec1a7506a5baeb
+  metadata.gz: d7c1746bfb06d696a267ff57810838ea0f5da577
+  data.tar.gz: 76133042dda4240b704a4a3f2903f1f5297ccc86
 SHA512:
-  metadata.gz: 254a66e4e0bd21eef9038bc8e756b2195cf0d4f0b817944e2f5c71ca139c40da3d0c3a99d7d540b92f77b4bdb5a6acade53efce5ffb839f61ca1a6dcfd01d46e
-  data.tar.gz: 7790a1eb890eeff8bdf7690df749b3841fbff88487d6ef39dc7f3e9679bdabb9854898ad833e9ed8c5427712f14af416ff6dee4d9ba92cecfe34f773997b1adc
+  metadata.gz: a2e690b8375aef1392a9d59a6d1e51be0eb177a5ffa8ffd82950baaf7103ba4315bd96a5530155bf214577a853ee250eddf1ec326cb7f8d7bd521e6818d594f3
+  data.tar.gz: 08f1879eb8ae822005635f386b4c6b89287d657d771adacfb7b8cc364a2240b36d8e18edd4db68913017b75dcbeac80c0747286c773536b0c00f29ac0e66d05c

data/lib/generators/graphiti/api_test_generator.rb

@@ -0,0 +1,71 @@
+$:.unshift File.dirname(__FILE__)
+require 'generator_mixin'
+
+module Graphiti
+  class ApiTestGenerator < ::Rails::Generators::Base
+    include GeneratorMixin
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :resource, type: :string
+    class_option :'actions',
+      type: :array,
+      default: nil,
+      aliases: ['--actions', '-a'],
+      desc: 'Array of controller actions, e.g. "index show destroy"'
+
+    desc 'Generates rspec request specs at spec/api'
+    def generate
+      generate_api_specs
+    end
+
+    private
+
+    def var
+      dir.singularize
+    end
+
+    def dir
+      @resource.gsub('Resource', '').underscore.pluralize
+    end
+
+    def generate_api_specs
+      if actions?('index')
+        to = "spec/api/v1/#{dir}/index_spec.rb"
+        template('index_request_spec.rb.erb', to)
+      end
+
+      if actions?('show')
+        to = "spec/api/v1/#{dir}/show_spec.rb"
+        template('show_request_spec.rb.erb', to)
+      end
+
+      if actions?('create')
+        to = "spec/api/v1/#{dir}/create_spec.rb"
+        template('create_request_spec.rb.erb', to)
+      end
+
+      if actions?('update')
+        to = "spec/api/v1/#{dir}/update_spec.rb"
+        template('update_request_spec.rb.erb', to)
+      end
+
+      if actions?('destroy')
+        to = "spec/api/v1/#{dir}/destroy_spec.rb"
+        template('destroy_request_spec.rb.erb', to)
+      end
+    end
+
+    def resource_class
+      @resource.constantize
+    end
+
+    def type
+      resource_class.type
+    end
+
+    def model_class
+      resource_class.model
+    end
+  end
+end

data/lib/generators/graphiti/generator_mixin.rb

@@ -0,0 +1,45 @@
+module Graphiti
+  module GeneratorMixin
+    def prompt(header: nil, description: nil, default: nil)
+      say(set_color("\n#{header}", :magenta, :bold)) if header
+      say("\n#{description}") if description
+      answer = ask(set_color("\n(default: #{default}):", :magenta, :bold))
+      answer = default if answer.blank? && default != 'nil'
+      say(set_color("\nGot it!\n", :white, :bold))
+      answer
+    end
+
+    def api_namespace
+      @api_namespace ||= begin
+        ns = graphiti_config['namespace']
+
+        if ns.blank?
+          ns = prompt \
+            header: "What is your API namespace?",
+            description: "This will be used as a route prefix, e.g. if you want the route '/books_api/v1/authors' your namespace would be 'books_api'",
+            default: 'api'
+          update_config!('namespace' => ns)
+        end
+
+        ns
+      end
+    end
+
+    def actions
+      @options['actions'] || %w(index show create update destroy)
+    end
+
+    def actions?(*methods)
+      methods.any? { |m| actions.include?(m) }
+    end
+
+    def graphiti_config
+      File.exists?('.graphiticfg.yml') ? YAML.load_file('.graphiticfg.yml') : {}
+    end
+
+    def update_config!(attrs)
+      config = graphiti_config.merge(attrs)
+      File.open('.graphiticfg.yml', 'w') { |f| f.write(config.to_yaml) }
+    end
+  end
+end

data/lib/generators/graphiti/resource_generator.rb

@@ -0,0 +1,99 @@
+$:.unshift File.dirname(__FILE__)
+require 'generator_mixin'
+
+module Graphiti
+  class ResourceGenerator < ::Rails::Generators::NamedBase
+    include GeneratorMixin
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+
+    class_option :'omit-comments',
+      type: :boolean,
+      default: false,
+      aliases: ['--omit-comments', '-c'],
+      desc: 'Generate without documentation comments'
+    class_option :'actions',
+      type: :array,
+      default: nil,
+      aliases: ['--actions', '-a'],
+      desc: 'Array of controller actions to support, e.g. "index show destroy"'
+
+    desc "This generator creates a resource file at app/resources, as well as corresponding controller/specs/route/etc"
+    def generate_all
+      unless model_klass
+        raise "You must define a #{class_name} model before generating the corresponding resource."
+      end
+
+      generate_controller
+      generate_application_resource unless application_resource_defined?
+      generate_route
+      generate_resource
+      generate_resource_specs
+      generate_api_specs
+    end
+
+    private
+
+    def omit_comments?
+      @options['omit-comments']
+    end
+
+    def responders?
+      defined?(Responders)
+    end
+
+    def generate_controller
+      to = File.join('app/controllers', class_path, "#{file_name.pluralize}_controller.rb")
+      template('controller.rb.erb', to)
+    end
+
+    def generate_application_resource
+      to = File.join('app/resources', class_path, "application_resource.rb")
+      template('application_resource.rb.erb', to)
+    end
+
+    def application_resource_defined?
+      'ApplicationResource'.safe_constantize.present?
+    end
+
+    def generate_route
+      code = "      resources :#{type}"
+      code << ", only: [#{actions.map { |a| ":#{a}" }.join(', ')}]" if actions.length < 5
+      code << "\n"
+      inject_into_file 'config/routes.rb', after: "scope path: '/v1' do\n" do
+        code
+      end
+    end
+
+    def generate_resource_specs
+      opts = {}
+      opts[:actions] = @options[:actions] if @options[:actions]
+      invoke 'graphiti:resource_test', [resource_klass], opts
+    end
+
+    def generate_api_specs
+      opts = {}
+      opts[:actions] = @options[:actions] if @options[:actions]
+      invoke 'graphiti:api_test', [resource_klass], opts
+    end
+
+    def generate_resource
+      to = File.join('app/resources', class_path, "#{file_name}_resource.rb")
+      template('resource.rb.erb', to)
+    end
+
+    def model_klass
+      class_name.safe_constantize
+    end
+
+    def resource_klass
+      "#{model_klass}Resource"
+    end
+
+    def type
+      model_klass.name.underscore.pluralize
+    end
+  end
+end

data/lib/generators/graphiti/resource_test_generator.rb

@@ -0,0 +1,57 @@
+$:.unshift File.dirname(__FILE__)
+require 'generator_mixin'
+
+module Graphiti
+  class ResourceTestGenerator < ::Rails::Generators::Base
+    include GeneratorMixin
+
+    source_root File.expand_path('../templates', __FILE__)
+
+    argument :resource, type: :string
+    argument :attributes, type: :array, default: [], banner: "field[:type][:index] field[:type][:index]"
+    class_option :'actions',
+      type: :array,
+      default: nil,
+      aliases: ['--actions', '-a'],
+      desc: 'Array of controller actions, e.g. "index show destroy"'
+
+    desc 'Generates rspec request specs at spec/api'
+    def generate
+      generate_resource_specs
+    end
+
+    private
+
+    def var
+      dir.singularize
+    end
+
+    def dir
+      @resource.gsub('Resource', '').underscore.pluralize
+    end
+
+    def generate_resource_specs
+      if actions?('create', 'update', 'destroy')
+        to = "spec/resources/#{var}/writes_spec.rb.rb"
+        template('resource_writes_spec.rb.erb', to)
+      end
+
+      if actions?('index', 'show')
+        to = "spec/resources/#{var}/reads_spec.rb.rb"
+        template('resource_reads_spec.rb.erb', to)
+      end
+    end
+
+    def resource_class
+      @resource.constantize
+    end
+
+    def type
+      resource_class.type
+    end
+
+    def model_class
+      resource_class.model
+    end
+  end
+end

data/lib/generators/{jsonapi → graphiti}/templates/create_request_spec.rb.erb

@@ -18,11 +18,11 @@ RSpec.describe "<%= type %>#create", type: :request do
     end
 
     it 'works' do
-      expect(<%= resource_klass %>).to receive(:build).and_call_original
+      expect(<%= resource_class %>).to receive(:build).and_call_original
       expect {
         make_request
-      }.to change { <%= model_klass %>.count }.by(1)
-      <%= file_name %> = <%= model_klass %>.last
+      }.to change { <%= model_class %>.count }.by(1)
+      <%= var %> = <%= model_class %>.last
       # assert on properties
       expect(response.status).to eq(201)
     end

data/lib/generators/{jsonapi → graphiti}/templates/destroy_request_spec.rb.erb

@@ -2,16 +2,16 @@ require 'rails_helper'
 
 RSpec.describe "<%= type %>#destroy", type: :request do
   subject(:make_request) do
-    jsonapi_delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= file_name %>.id}"
+    jsonapi_delete "/<%= api_namespace %>/v1/<%= type %>/#{<%= var %>.id}"
   end
 
   describe 'basic destroy' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+    let!(:<%= var %>) { create(:<%= var %>) }
 
     it 'updates the resource' do
-      expect(<%= resource_klass %>).to receive(:find).and_call_original
-      expect { make_request }.to change { <%= model_klass %>.count }.by(-1)
-      expect { <%= file_name %>.reload }
+      expect(<%= resource_class %>).to receive(:find).and_call_original
+      expect { make_request }.to change { <%= model_class %>.count }.by(-1)
+      expect { <%= var %>.reload }
         .to raise_error(ActiveRecord::RecordNotFound)
       expect(response.status).to eq(200)
       expect(json).to eq('meta' => {})

data/lib/generators/graphiti/templates/index_request_spec.rb.erb

@@ -0,0 +1,22 @@
+require 'rails_helper'
+
+RSpec.describe "<%= type %>#index", type: :request do
+  let(:params) { {} }
+
+  subject(:make_request) do
+    jsonapi_get "/<%= api_namespace %>/v1/<%= type %>", params: params
+  end
+
+  describe 'basic fetch' do
+    let!(:<%= var %>1) { create(:<%= var %>) }
+    let!(:<%= var %>2) { create(:<%= var %>) }
+
+    it 'works' do
+      expect(<%= resource_class %>).to receive(:all).and_call_original
+      make_request
+      expect(response.status).to eq(200)
+      expect(d.map(&:jsonapi_type).uniq).to eq(['<%= type %>'])
+      expect(d.map(&:id)).to match_array([<%= var %>1.id, <%= var %>2.id])
+    end
+  end
+end

data/lib/generators/{jsonapi → graphiti}/templates/resource_reads_spec.rb.erb

@@ -1,14 +1,14 @@
 require 'rails_helper'
 
-RSpec.describe <%= resource_klass %>, type: :resource do
+RSpec.describe <%= resource_class %>, type: :resource do
   describe 'serialization' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+    let!(:<%= var %>) { create(:<%= var %>) }
 
     it 'works' do
       render
       data = jsonapi_data[0]
-      expect(data.id).to eq(<%= file_name %>.id)
-      expect(data.jsonapi_type).to eq('<%= file_name.pluralize %>')
+      expect(data.id).to eq(<%= var %>.id)
+      expect(data.jsonapi_type).to eq('<%= type %>')
       <%- attributes.each do |a| -%>
       <%- if [:created_at, :updated_at].include?(a.name.to_sym) -%>
       expect(data.<%= a.name %>).to eq(datetime(<%= file_name %>.<%= a.name %>))
@@ -21,25 +21,25 @@ RSpec.describe <%= resource_klass %>, type: :resource do
   <%- if actions?('index') -%>
 
   describe 'filtering' do
-    let!(:<%= file_name %>1) { create(:<%= file_name %>) }
-    let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+    let!(:<%= var %>1) { create(:<%= var %>) }
+    let!(:<%= var %>2) { create(:<%= var %>) }
 
     context 'by id' do
       before do
-        params[:filter] = { id: { eq: <%= file_name %>2.id } }
+        params[:filter] = { id: { eq: <%= var %>2.id } }
       end
 
       it 'works' do
         render
-        expect(d.map(&:id)).to eq([<%= file_name %>2.id])
+        expect(d.map(&:id)).to eq([<%= var %>2.id])
       end
     end
   end
 
   describe 'sorting' do
     context 'by id descending' do
-      let!(:<%= file_name %>1) { create(:<%= file_name %>) }
-      let!(:<%= file_name %>2) { create(:<%= file_name %>) }
+      let!(:<%= var %>1) { create(:<%= var %>) }
+      let!(:<%= var %>2) { create(:<%= var %>) }
 
       before do
         params[:sort] = '-id'
@@ -48,8 +48,8 @@ RSpec.describe <%= resource_klass %>, type: :resource do
       it 'works' do
         render
         expect(d.map(&:id)).to eq([
-          <%= file_name %>2.id,
-          <%= file_name %>1.id
+          <%= var %>2.id,
+          <%= var %>1.id
         ])
       end
     end

data/lib/generators/{jsonapi → graphiti}/templates/resource_writes_spec.rb.erb

@@ -1,63 +1,63 @@
 require 'rails_helper'
 
-RSpec.describe <%= resource_klass %>, type: :resource do
+RSpec.describe <%= resource_class %>, type: :resource do
   describe 'creating' do
     let(:payload) do
       {
         data: {
-          type: '<%= file_name.pluralize %>',
+          type: '<%= type %>',
           attributes: { }
         }
       }
     end
 
     let(:instance) do
-      <%= resource_klass %>.build(payload)
+      <%= resource_class %>.build(payload)
     end
 
     it 'works' do
       expect {
         expect(instance.save).to eq(true)
-      }.to change { <%= model_klass %>.count }.by(1)
+      }.to change { <%= model_class %>.count }.by(1)
     end
   end
 
   describe 'updating' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+    let!(:<%= var %>) { create(:<%= var %>) }
 
     let(:payload) do
       {
         data: {
-          id: <%= file_name %>.id.to_s,
-          type: '<%= file_name.pluralize %>',
+          id: <%= var %>.id.to_s,
+          type: '<%= type %>',
           attributes: { } # Todo!
         }
       }
     end
 
     let(:instance) do
-      <%= resource_klass %>.find(payload)
+      <%= resource_class %>.find(payload)
     end
 
     xit 'works (add some attributes and enable this spec)' do
       expect {
         expect(instance.update_attributes).to eq(true)
-      }.to change { <%= file_name %>.reload.updated_at }
+      }.to change { <%= var %>.reload.updated_at }
       # and change { instance.foo }.to('bar') <- example
     end
   end
 
   describe 'destroying' do
-    let!(:<%= file_name %>) { create(:<%= file_name %>) }
+    let!(:<%= var %>) { create(:<%= var %>) }
 
     let(:instance) do
-      <%= resource_klass %>.find(id: <%= file_name %>.id)
+      <%= resource_class %>.find(id: <%= var %>.id)
     end
 
     it 'works' do
       expect {
         expect(instance.destroy).to eq(true)
-      }.to change { <%= model_klass %>.count }.by(-1)
+      }.to change { <%= model_class %>.count }.by(-1)
     end
   end
 end