generic_controller 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ae2943e8da1b0ecfc4f14dd322fe1e30e6ef4f47
+  data.tar.gz: 2fabdff692eb2e2fcd5dc3253df6379e0c0e07c7
+SHA512:
+  metadata.gz: 1e15d536349a170dcb8374a1d7c2ff877e51a89ea729da478597e6abf69e9f10d958afed1f124d4b3aa2ba9fde76fe402bac40f0202cd196044d9f7682e8162f
+  data.tar.gz: 11aed9c46035d6c6a5852349d248411519ed3aa95e82f4d46810d5c00ddfd185f10bf0217e9a236e3763c88ffd633b9c39c93af21efabb7e789aafa61135eb8b

data/lib/generic_controller.rb

@@ -0,0 +1,130 @@
+# GenericController: Generic, scope-oriented resource controller functions
+require 'action_controller'
+class GenericController < ActionController::Base
+  VERSION = "0.0.1"
+  VALID_SORT = %w(asc desc).freeze
+
+  def create
+    @resource = cscope.new(model_params)
+    @resource.save!
+    respond_to do |f|
+      f.any do
+        response.headers['location'] = send("v#{api_version}_#{model_name.underscore}_url", @resource)
+        render({ json: @resource,
+                 serializer: each_sez,
+                 status: :created }.merge!(render_options))
+      end
+    end
+  end
+
+  def destroy
+    model.destroy(params[:id])
+    respond_to do |f|
+      f.any do
+        head :no_content
+      end
+    end
+  end
+
+  def show
+    respond_to do |f|
+      f.any do
+        render({
+                 json: @resource,
+                 serializer: each_sez,
+                 status: :ok
+               }.merge!(render_options))
+      end
+    end
+  end
+
+  def update
+    @resource.attributes = model_params
+    @resource.save!
+    respond_to do |f|
+      f.any do
+        render({
+                 json: @resource,
+                 serializer: each_sez,
+                 status: :ok
+               }.merge!(render_options))
+      end
+    end
+  end
+
+  def index
+    query = cscope
+    l = limit.to_i
+    p = page.to_i
+    o = order_by.to_sym
+    s = sort.to_sym
+    respond_to do |f|
+      f.any do
+        render({
+                 json: query.order(o => s).page(p).per(l),
+                 meta: {
+                   total: query.count(:all),
+                   page: p,
+                   limit: l,
+                   order_by: o,
+                   sort: s
+                 },
+                 each_serializer: each_sez,
+                 status: :ok
+               }.merge!(render_options))
+      end
+    end
+  end
+
+  private
+
+  def render_options
+    {}
+  end
+
+  def each_sez
+    "#{norm_controller_name}Serializer".constantize
+  end
+
+  def page
+    params[:page] ||= 1
+  end
+
+  def limit
+    params[:limit] ||= 20
+  end
+
+  def order_by
+    return params[:order_by] if model.column_names.include?(params[:order_by])
+
+    'id'
+  end
+
+  def sort
+    params[:sort].in?(VALID_SORT) ? params[:sort] : VALID_SORT[0]
+  end
+
+  def norm_controller_name
+    controller_path.classify
+  end
+
+  def model_name
+    controller_name.classify
+  end
+
+  def model
+    model_name.constantize
+  end
+
+  def cscope
+    model
+  end
+
+  def attach_resource
+    @resource ||= cscope.find(params[:id])
+  end
+
+  def api_version
+    self.class.to_s.split('::').first.delete!('V')
+  end
+end

data/spec/lib/generic_controller_spec.rb

@@ -0,0 +1,26 @@
+require 'generic_controller'
+RSpec.describe GenericController do
+  controller = nil
+  before(:all) do
+    module Bongo; end
+    class FooBarBaz; end
+    module Bongo
+      class FooBarBazController < GenericController; end
+    end
+    controller = Bongo::FooBarBazController.new
+  end
+  describe '#model' do
+    it 'classifies the correct model' do
+      expect(controller.send(:model)).to eq(FooBarBaz)
+    end
+  end
+  describe '#page' do
+    let(:params) { instance_double('params') }
+    let(:page_count) { 2 }
+    specify do
+      allow(params).to receive(:[]).with(:page).and_return(page_count)
+      allow(controller).to receive(:params).and_return(params)
+      expect(controller.send(:page)).to eq(page_count)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+
+Bundler.setup
+Bundle.require :default, :test
+
+require 'generic_controller'

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: generic_controller
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- James Meldrum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: An opinionated generic resource-oriented controller for rails.
+email:
+- htmldrum@tutanota.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/generic_controller.rb
+- spec/lib/generic_controller_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/htmldrum/generic_controller
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: generic_controller
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: ActionController subclass with conveience
+test_files: []
+has_rdoc: