azeroth 0.0.5 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932722b68ea70d25532bae9611143e1858edbe50b38459bf1134b6429ec960e0
-  data.tar.gz: 77b46098f931ba91e40e00b28b8d4fe823cc81bdaeebcbb8f9e44a0d2ab150c0
+  metadata.gz: 670fc994395afb0d20d4a113976c2b813d151ca6cad00d928e145d904294bcbc
+  data.tar.gz: 8c6f020d5e79b0dfc1559672a57d24468e883ec750e6503032e289deed19328b
 SHA512:
-  metadata.gz: c4bad15f9ba9d71be3da8a48507cd3a96b9834892ed14001abd3122b780d465a787da7c34979222f7b13a1603c5510265c6b09ea9e92f7b176f9a6307741b737
-  data.tar.gz: 8c437bf58301cfc6a28893b7bdff6390beed0640c843be66d662505cfb582200e7f847333ac6d7b5b4719e4bb3fb5af26408844d62899e77846e14fceef229f0
+  metadata.gz: caf235cb34805e990b810e396859b42a6937eaa14f54cfff32cfa34867e716b180f0634a00e81042b56e0ce3b0851c08d5e3927b16da3c4138f3134703536e81
+  data.tar.gz: 2adb8cf2c8751e7c3e6cb7dcda4591285565d4b1e6deee999cbbeb6f941127e4b3c3b454fbf65e38c40ae9caa1de02d1562ff77b3ec9e6d4752c1b9f58dbf426

data/.gitignore

@@ -7,3 +7,6 @@ doc
 measurement/
 **/*.swp
 rubycritic/
+spec/dummy/log/*
+spec/dummy/tmp/*
+spec/dummy/db/*.sqlite3

data/README.md

@@ -9,4 +9,4 @@ Azeroth
 
 Yard Documentation
 -------------------
-https://www.rubydoc.info/gems/azeroth/0.0.5
+https://www.rubydoc.info/gems/azeroth/0.0.6

data/azeroth.gemspec

@@ -22,23 +22,26 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'darthjee-active_ext', '>= 1.3.2'
   gem.add_runtime_dependency 'sinclair', '>= 1.5.2'
 
-  gem.add_development_dependency 'actionpack', '~> 5.x'
-  gem.add_development_dependency 'activerecord', '~> 5.x'
-  gem.add_development_dependency 'bundler', '~> 1.16.1'
-  gem.add_development_dependency 'pry', '0.12.2'
-  gem.add_development_dependency 'pry-nav', '0.3.0'
-  gem.add_development_dependency 'rake', '12.3.3'
-  gem.add_development_dependency 'reek', '5.4.0'
-  gem.add_development_dependency 'rspec', '3.8.0'
-  gem.add_development_dependency 'rspec-core', '3.8.0'
-  gem.add_development_dependency 'rspec-expectations', '3.8.3'
-  gem.add_development_dependency 'rspec-mocks',        '3.8.0'
-  gem.add_development_dependency 'rspec-support',      '3.8.0'
-  gem.add_development_dependency 'rubocop',            '0.73.0'
-  gem.add_development_dependency 'rubocop-rspec',      '1.33.0'
-  gem.add_development_dependency 'rubycritic',         '4.1.0'
-  gem.add_development_dependency 'simplecov',          '0.17.0'
-  gem.add_development_dependency 'sqlite3', '>= 1.3.13'
-  gem.add_development_dependency 'yard',               '0.9.20'
-  gem.add_development_dependency 'yardstick',          '0.9.9'
+  gem.add_development_dependency 'actionpack',               '~> 5.x'
+  gem.add_development_dependency 'activerecord',             '~> 5.x'
+  gem.add_development_dependency 'bundler',                  '~> 1.16.1'
+  gem.add_development_dependency 'pry',                      '0.12.2'
+  gem.add_development_dependency 'pry-nav',                  '0.3.0'
+  gem.add_development_dependency 'rails',                    '>= 5.2.0'
+  gem.add_development_dependency 'rails-controller-testing', '1.0.4'
+  gem.add_development_dependency 'rake',                     '12.3.3'
+  gem.add_development_dependency 'reek',                     '5.4.0'
+  gem.add_development_dependency 'rspec',                    '3.8.0'
+  gem.add_development_dependency 'rspec-core',               '3.8.0'
+  gem.add_development_dependency 'rspec-expectations',       '3.8.3'
+  gem.add_development_dependency 'rspec-mocks',              '3.8.0'
+  gem.add_development_dependency 'rspec-rails',              '3.8.0'
+  gem.add_development_dependency 'rspec-support',            '3.8.0'
+  gem.add_development_dependency 'rubocop',                  '0.73.0'
+  gem.add_development_dependency 'rubocop-rspec',            '1.33.0'
+  gem.add_development_dependency 'rubycritic',               '4.1.0'
+  gem.add_development_dependency 'simplecov',                '0.17.0'
+  gem.add_development_dependency 'sqlite3',                  '>= 1.3.13'
+  gem.add_development_dependency 'yard',                     '0.9.20'
+  gem.add_development_dependency 'yardstick',                '0.9.9'
 end

data/bin/test

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH << File.expand_path('../test', __dir__)
+
+require 'bundler/setup'
+require 'rails/plugin/test'

data/config/check_specs.yml

@@ -1,4 +1,5 @@
 ignore:
+  - lib/azeroth/resourceable/class_methods.rb
   - lib/azeroth/resourceable.rb
   - lib/azeroth/version.rb
   - lib/azeroth/options.rb

data/config/yardstick.yml

@@ -1,4 +1,4 @@
-threshold: 98.5
+threshold: 96.5
 require_exact_threshold: false
 rules:
   ApiTag::Presence:

data/lib/azeroth.rb

@@ -1,5 +1,10 @@
 # frozen_string_literal: true
 
+# @api public
+#
+# Lib for easily developing controllers
+#
+# @see Resourceable
 module Azeroth
   autoload :Model,                'azeroth/model'
   autoload :Resourceable,         'azeroth/resourceable'

data/lib/azeroth/resourceable.rb

@@ -3,17 +3,32 @@
 require 'active_support'
 
 module Azeroth
+  # @api public
+  # @author Darthjee
+  #
+  # Concern for building controller methods for the routes
   module Resourceable
     extend ActiveSupport::Concern
 
+    included do
+      rescue_from ActiveRecord::RecordNotFound, with: :not_found
+    end
+
     autoload :Builder, 'azeroth/resourceable/builder'
+    autoload :ClassMethods, 'azeroth/resourceable/class_methods'
+
+    private
 
-    class_methods do
-      def resource_for(name, **options)
-        Builder.new(
-          self, name, Azeroth::Options.new(options)
-        ).build
+    def render_basic
+      action = params[:action]
+      respond_to do |format|
+        format.json { render json: send("#{action}_resource") }
+        format.html { action }
       end
     end
+
+    def not_found
+      head :not_found
+    end
   end
 end

data/lib/azeroth/resourceable/class_methods.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Azeroth
+  module Resourceable
+    # @api public
+    # @author Darthjee
+    #
+    # Class methods added by {Resourceable}
+    module ClassMethods
+      # Adds resource methods for resource
+      #
+      # @param name [String, Symbol] Name of the resource
+      # @param options [Hash]
+      def resource_for(name, **options)
+        Builder.new(
+          self, name, Azeroth::Options.new(options)
+        ).build
+      end
+    end
+  end
+end

data/lib/azeroth/routes_builder.rb

@@ -19,10 +19,13 @@ module Azeroth
     #
     # @return [Array<Sinclair::MethodDefinition>]
     def append
-      %i[index show new edit create update].each do |route|
+      %i[index show edit].each do |route|
         add_method(route, 'render_basic')
       end
 
+      add_method(:new, '')
+      add_method(:update,  update_code)
+      add_method(:create,  create_code)
       add_method(:destroy, destroy_code)
     end
 
@@ -54,6 +57,18 @@ module Azeroth
     #
     # @return [Array<Sinclair::MethodDefinition>]
 
+    def update_code
+      <<-RUBY
+        render json: update_resource
+      RUBY
+    end
+
+    def create_code
+      <<-RUBY
+        render json: create_resource
+      RUBY
+    end
+
     # @private
     #
     # Method code to destrou route

data/lib/azeroth/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Azeroth
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/spec/controllers/documents_controller_spec.rb

@@ -0,0 +1,256 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DocumentsController do
+  let(:parsed_response) do
+    JSON.parse(response.body)
+  end
+
+  describe 'GET index' do
+    let(:documents_count) { 0 }
+    let!(:documents) do
+      documents_count.times.map do
+        Document.create
+      end
+    end
+
+    context 'when calling on format json' do
+      before do
+        get :index, params: { format: :json }
+      end
+
+      it { expect(response).to be_successful }
+
+      it 'returns empty array' do
+        expect(parsed_response).to eq([])
+      end
+
+      context 'when there is a document' do
+        let(:documents_count) { 1 }
+
+        it { expect(response).to be_successful }
+
+        it 'renders documents json' do
+          expect(parsed_response).to eq(documents.as_json)
+        end
+      end
+    end
+
+    context 'when calling on format html' do
+      before do
+        get :index, params: { format: :html }
+      end
+
+      it { expect(response).to be_successful }
+
+      it { expect(response).to render_template('documents/index') }
+    end
+  end
+
+  describe 'GET show' do
+    let(:document)    { Document.create }
+    let(:document_id) { document.id }
+
+    context 'when calling on format json' do
+      before do
+        get :show, params: { id: document_id, format: :json }
+      end
+
+      it { expect(response).to be_successful }
+
+      it 'returns document json' do
+        expect(parsed_response).to eq(document.as_json)
+      end
+    end
+
+    context 'when calling on an inexistent id' do
+      let(:document_id) { :wrong_id }
+
+      before do
+        get :show, params: { id: document_id, format: :json }
+      end
+
+      it { expect(response).not_to be_successful }
+      it { expect(response.status).to eq(404) }
+
+      it 'returns empty body' do
+        expect(response.body).to eq('')
+      end
+    end
+
+    context 'when calling on format html' do
+      before do
+        get :show, params: { id: :id, format: :html }
+      end
+
+      it { expect(response).to be_successful }
+
+      it { expect(response).to render_template('documents/show') }
+    end
+  end
+
+  describe 'POST create' do
+    let(:parameters) do
+      {
+        document: {
+          name: 'My document'
+        }
+      }
+    end
+
+    it do
+      post :create, params: parameters
+      expect(response).to be_successful
+    end
+
+    it 'returns created document json' do
+      post :create, params: parameters
+      expect(parsed_response).to eq(Document.last.as_json)
+    end
+
+    it do
+      expect { post :create, params: parameters }
+        .to change(Document, :count).by(1)
+    end
+  end
+
+  describe 'PATCH update' do
+    let(:document)    { Document.create }
+    let(:document_id) { document.id }
+
+    let(:parameters) do
+      {
+        id: document_id,
+        document: {
+          name: 'My document'
+        }
+      }
+    end
+
+    it do
+      patch :update, params: parameters
+      expect(response).to be_successful
+    end
+
+    it 'returns updated document json' do
+      patch :update, params: parameters
+      expect(parsed_response).to eq(Document.last.as_json)
+    end
+
+    it do
+      expect { patch :update, params: parameters }
+        .to change { document.reload.name }
+        .from(nil).to('My document')
+    end
+
+    context 'when calling on an inexistent id' do
+      let(:document_id) { :wrong_id }
+
+      before do
+        patch :update, params: parameters
+      end
+
+      it { expect(response).not_to be_successful }
+      it { expect(response.status).to eq(404) }
+
+      it 'returns empty body' do
+        expect(response.body).to eq('')
+      end
+    end
+  end
+
+  describe 'GET new' do
+    before { get :new }
+
+    it do
+      expect(response).to be_successful
+    end
+
+    it { expect(response).to render_template('documents/new') }
+  end
+
+  describe 'GET edit' do
+    let(:document)    { Document.create }
+    let(:document_id) { document.id }
+
+    context 'when calling on format json' do
+      before do
+        get :edit, params: { id: document_id, format: :json }
+      end
+
+      it { expect(response).to be_successful }
+
+      it 'returns document json' do
+        expect(parsed_response).to eq(document.as_json)
+      end
+    end
+
+    context 'when calling on an inexistent id' do
+      let(:document_id) { :wrong_id }
+
+      before do
+        get :edit, params: { id: document_id, format: :json }
+      end
+
+      it { expect(response).not_to be_successful }
+      it { expect(response.status).to eq(404) }
+
+      it 'returns empty body' do
+        expect(response.body).to eq('')
+      end
+    end
+
+    context 'when calling on format html' do
+      before do
+        get :edit, params: { id: :id, format: :html }
+      end
+
+      it { expect(response).to be_successful }
+
+      it { expect(response).to render_template('documents/edit') }
+    end
+  end
+
+  describe 'DELETE destroy' do
+    let!(:document)   { Document.create }
+    let(:document_id) { document.id }
+
+    let(:parameters) do
+      {
+        id: document_id
+      }
+    end
+
+    it do
+      delete :destroy, params: parameters
+      expect(response).to be_successful
+    end
+
+    it do
+      delete :destroy, params: parameters
+      expect(response.body).to eq('')
+    end
+
+    it do
+      expect { delete :destroy, params: parameters }
+        .to change(Document, :count)
+        .by(-1)
+    end
+
+    context 'when calling on an inexistent id' do
+      let(:document_id) { :wrong_id }
+
+      before do
+        delete :destroy, params: parameters
+      end
+
+      it { expect(response).not_to be_successful }
+      it { expect(response.status).to eq(404) }
+
+      it 'returns empty body' do
+        expect(response.body).to eq('')
+      end
+    end
+  end
+end