ddc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f3a6ee066211a5a1664cda8df754f8dd14d6bc07
+  data.tar.gz: 23a9ecdcb2c841d6b78e51e1dce499f90197e2ea
+SHA512:
+  metadata.gz: dffde5c7259d6cc663a5efcb354b4a4549009a6ea360fedeaf58ff48f4e7a0dd17700deb71fa124e5770bd9e9550cb925c575329d111407abc9501cfce4db85a
+  data.tar.gz: fb195d4f69292e9481af00a52d03fe8e2cb8c56cfd4f9fdc713397512448b154e80b6fbea2af0704fdef5a2c803af96760fb900cfa26c7a03751730823888826

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ddc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Shawn Anderson
+
+MIT License
+
+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,122 @@
+# DDC
+
+DDC (Data Driven Controllers) let's you declare how to wire Rails into your app without the need for code. A Rails controller's job is parsing/interpreting parameters to send to your application domain and taking those results and translating them back out to an HTTP result (html/status/headers). DDC removes the need for all the boiler plate controller code and tests.
+
+By adhering to a couple of interfaces, you can avoid writing most controller code and tests. See this [blog post]( http://spin.atomicobject.com/2015/01/26/data-driven-rails-controllers) for more information.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ddc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ddc
+
+## Usage
+
+### Controllers
+
+`controllers/monkeys_controller.rb`
+
+```ruby
+DDC::ControllerBuilder.build :monkeys
+  before_actions: [:authenticate_user!],
+  actions: {
+    show: {
+      context: 'context_builder#user_and_id',
+      service: 'monkey_service#find'
+    },
+    index: {
+      context: 'context_builder#user',
+      service: 'monkey_service#find_all'
+    },
+    update: {
+      context: 'context_builder#monkey',
+      service: 'monkey_service#update'
+    },
+    create: {
+      context: 'context_builder#monkey',
+      service: 'monkey_service#create'
+    }
+  }
+```
+
+### Context Builders
+`lib/context_builder.rb`
+
+```ruby
+class ContextBuilder
+  def user(context_params)
+    HashWithIndifferentAccess.new current_user: context_params[:current_user] 
+  end
+
+  def user_and_id(context_params)
+    user(context_params).merge(id: context_params[:params][:id])
+  end
+
+  def monkey(context_params)
+    info = context_params[:params].permit(monkey: [:color, :poo])
+    user_and_id(context_params).merge(info)
+  end
+end
+```
+
+
+### Services
+
+`lib/monkeys_service.rb`
+
+```ruby
+class MonkeyService
+  def find(context)
+    id, user = context.values_at :id, :current_user
+    me = find_for_user user, id
+    if me.present?
+      ok(me)
+    else
+      not_found
+    end
+  end
+
+  def update(context)
+    id, user, updates = context.values_at :id, :current_user, @model_type
+    me = find_for_user user, id
+
+    translated_updates = translated_cid_to_id(updates)
+    
+    if me.present?
+      me.update_attributes translated_updates
+      ok(me)
+    else
+      not_found
+    end
+  end
+
+  private
+  def not_found
+    {status: :not_found}.freeze
+  end
+  def ok(obj)
+    {status: :ok, object: obj}
+  end
+end
+
+# shortcut for default CRUD service
+MonkeyService = DDC::ServiceBuilder.build(:monkey)
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ddc/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/ddc.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ddc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ddc"
+  spec.version       = Ddc::VERSION
+  spec.authors       = ["Shawn Anderson"]
+  spec.email         = ["shawn42@gmail.com"]
+  spec.summary       = %q{Data Driven Controllers for Rails}
+  spec.description   = %q{Use data to tell Rails how to interact with your domain.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "actionpack", "~> 4.1"
+  spec.add_dependency "activesupport", "~> 4.1"
+
+end

data/lib/ddc.rb

@@ -0,0 +1,6 @@
+require "ddc/version"
+require "ddc/controller_builder"
+
+module Ddc
+  # Your code goes here...
+end

data/lib/ddc/controller_builder.rb

@@ -0,0 +1,98 @@
+module DDC
+  class ControllerBuilder
+    DEFAULT_CONTEXT_PARAMS = [:params]
+    DEFAULT_STATUSES = {
+      ok: 200,
+      created: 201,
+      not_found: 404,
+      not_allowed: 401,
+      error: 500
+    }
+    class << self
+      def build_controller(controller_name, config)
+        klass = find_or_create_class(controller_name)
+        setup_before_actions!(klass, config)
+        setup_actions!(controller_name, klass, config)
+        klass
+      end
+
+
+      def find_or_create_class(controller_name)
+        controller_klass_name = controller_name.to_s.camelize+'Controller'
+        klass = nil
+        if Object.constants.include?(controller_klass_name.to_sym)
+          klass = Object.const_get(controller_klass_name)
+        else
+          klass = Class.new(ApplicationController)
+          Object.const_set(controller_klass_name, klass)
+        end
+      end
+
+      def setup_before_actions!(klass, config)
+        (config[:before_actions] || []).each do |ba|
+          klass.before_action ba
+        end
+      end
+
+      def setup_actions!(controller_name, klass, config)
+        actions = config[:actions]
+        raise "Must specify actions" if actions.blank?
+
+        actions.each do |action, action_desc|
+          setup_action! controller_name, klass, action, action_desc
+        end
+      end
+
+      def setup_action!(controller_name, klass, action, action_desc)
+        raise "Must specify a service for each action" unless action_desc[:service].present?
+        raise "Must specify a context for each action" unless action_desc[:context].present?
+        proc_klass, proc_method = parse_class_and_method(action_desc[:service])
+        context_klass, context_method = parse_class_and_method(action_desc[:context])
+
+        klass.send :define_method, action do
+          context_params = (action_desc[:params] || DEFAULT_CONTEXT_PARAMS).inject({}) do |h, param|
+            h[param] = send param
+            h
+          end
+          context = context_klass.new.send(context_method, context_params)
+
+          result = proc_klass.new.send(proc_method, context)
+          obj = result[:object]
+          errors = result[:errors] || []
+          plural_model_name = controller_name.to_s
+          model_name = plural_model_name.singularize
+
+          # alias in object as model name
+          if obj.is_a? Enumerable
+            result[plural_model_name] ||= obj
+          else
+            result[model_name] ||= obj
+          end
+
+          status = DEFAULT_STATUSES.merge(action_desc[:status]||{})[result[:status]]
+
+          respond_to do |format|
+            format.json do
+              if obj.nil?
+                render json: {errors: errors}, status: status
+              else
+                render json: obj, status: status
+              end
+            end
+            format.html do
+              result.each do |k,v|
+                instance_variable_set("@#{k}", v)
+              end
+            end
+          end
+        end
+      end
+
+      def parse_class_and_method(str)
+        under_klass, method = str.split('#')
+        [Object.const_get(under_klass.camelize), method]
+      end
+    end
+  end
+
+end

data/lib/ddc/response_builder.rb

@@ -0,0 +1,11 @@
+module ResponseBuilder
+  def not_found
+    {status: :not_found}
+  end
+  def ok(obj)
+    {status: :ok, object: obj}
+  end
+  def created(obj)
+    {status: :created, object: obj}
+  end
+end

data/lib/ddc/service_builder.rb

@@ -0,0 +1,54 @@
+module DDC
+  class ServiceBuilder
+    def self.build(model_type)
+      Class.new  do
+        include ResponseBuilder
+        class << self
+          attr_accessor :model_type, :ar_model
+        end
+
+        @model_type = model_type
+        ar_class_name = model_type.to_s.camelize
+        @ar_model = Object.const_get(ar_class_name)
+
+        def find(context)
+          id = context.values_at :id
+          me = self.class.ar_model.where id: id
+          if me.present?
+            ok(me)
+          else
+            not_found
+          end
+        end
+
+        def find_all(context)
+          mes = self.class.ar_model.all
+          ok(mes)
+        end
+
+        def update(context)
+          id, updates = context.values_at :id, self.class.model_type
+          me = self.class.ar_model.where id: id
+
+          if me.present?
+            me.update_attributes translated_updates
+            ok(me)
+          else
+            not_found
+          end
+        end
+
+        def create(context)
+          attributes = context.values_at self.class.model_type
+          me = self.class.ar_model.create attributes
+          created(me)
+        end
+
+        private
+        def find_for_user(user, id)
+          return nil if id.nil? || !UUIDUtil.valid?(id)
+        end
+      end
+    end
+  end
+end

data/lib/ddc/version.rb

@@ -0,0 +1,3 @@
+module Ddc
+  VERSION = "0.0.1"
+end

data/spec/controller_builder_spec.rb

@@ -0,0 +1,181 @@
+require 'spec_helper'
+
+describe DDC::ControllerBuilder do
+  subject { described_class }
+
+  describe '.build_controller' do
+    let(:json_format) {
+      format = double('json format')
+      expect(format).to receive(:json).and_yield
+      expect(format).to receive(:html)
+      format }
+    let(:html_format) {
+      format = double('html format')
+      expect(format).to receive(:html).and_yield
+      expect(format).to receive(:json)
+      format }
+    after do
+      klass_to_cleanup = :FooController
+      Object.send :remove_const, klass_to_cleanup if Object.constants.include?(klass_to_cleanup)
+    end
+
+    it 'defines the controller class' do
+      subject.build_controller :foo, actions: {
+        index: {
+          params: [:current_user, :params],
+          context: 'foo_context_builder#bar',
+          service: 'baz_service#qux'
+        }
+      }
+      expect(Object.const_get("FooController")).not_to be_nil
+    end
+
+    it 'raises if there are no actions defined' do
+      expect(->{subject.build_controller :foo, actions: {}}).to raise_exception
+      expect(->{subject.build_controller :foop, {}}).to raise_exception
+    end
+
+    it 'raises if an action is missing context' do
+      expect(->{subject.build_controller :foo, actions: {foo: {
+        params: [:current_user, :params],
+        service: 'baz_service#qux'
+      }}}).to raise_exception
+    end
+
+    it 'raises if an action is missing service' do
+      expect(->{subject.build_controller :foo, actions: {foo: {
+        context: 'foo_context_builder#bar',
+      }}}).to raise_exception
+    end
+
+    it 'adds the before actions' do
+      class FooController
+        def self.before_action(*args);end
+      end
+
+      expect(FooController).to receive(:before_action).with(:my_before_action)
+      subject.build_controller :foo, 
+        before_actions: [:my_before_action],
+        actions: {
+          index: {
+            context: 'foo_context_builder#bar',
+            service: 'baz_service#qux'
+          }
+        }
+
+    end
+
+    it 'sunny day get params, process, return object and status, render' do 
+      class FooController
+        def current_user; end
+        def some_user; end
+        def render(args); end
+        def respond_to; end
+      end
+      controller = FooController.new
+
+      expect(controller).to receive_messages(
+        current_user: :some_user,
+        params: {a: :b})
+
+      render_args = nil
+      expect(controller).to receive(:render) do |args|
+        render_args = args
+      end
+      expect(controller).to receive(:respond_to) do |&block|
+        block.call(json_format)
+      end
+      expect_any_instance_of(FooContextBuilder).to receive(:bar).with(hash_including(
+        current_user: :some_user,
+        params: {a: :b})) { :context }
+
+      expect_any_instance_of(BazService).to receive(:qux).with(:context) do 
+        { object: :some_obj, status: :ok }
+      end
+
+      subject.build_controller :foo, actions: {
+        index: {
+          params: [:current_user, :params],
+          context: 'foo_context_builder#bar',
+          service: 'baz_service#qux'
+        }
+      }
+      controller.index
+
+      expect(render_args).to eq(json: :some_obj, status: 200)
+    end
+
+    it 'renders error if service returns nil object' do
+      class FooController
+        def current_user; end
+        def some_user; end
+        def render(args); end
+        def respond_to; end
+      end
+
+      subject.build_controller :foo, actions: {
+        index: {
+          params: [:current_user, :params],
+          context: 'foo_context_builder#bar',
+          service: 'baz_service#qux'
+        }
+      }
+      controller = FooController.new
+      expect(controller).to receive_messages(
+        current_user: :some_user,
+        params: {a: :b})
+
+      render_args = nil
+      expect(controller).to receive(:render) do |args|
+        render_args = args
+      end
+      expect(controller).to receive(:respond_to) do |&block|
+        block.call(json_format)
+      end
+
+      expect_any_instance_of(FooContextBuilder).to receive(:bar).with(hash_including(
+        current_user: :some_user,
+        params: {a: :b})) { :context }
+
+      expect_any_instance_of(BazService).to receive(:qux).with(:context) do 
+        { status: :error, errors: ["BOOM"] }
+      end
+
+      controller.index
+      expect(render_args).to eq(json: {errors: ["BOOM"]}, status: 500)
+    end
+
+    it 'defines all the action methods' do
+      class FooController
+        def current_user; end
+        def some_user; end
+        def render(args); end
+      end
+      subject.build_controller :foo, 
+        params: [:current_user, :params],
+        actions: {
+          index: {
+            context: 'foo_context_builder#bar',
+            service: 'baz_service#qux'
+          },
+          other: {
+            context: 'foo_context_builder#bar',
+            service: 'baz_service#qux'
+          }
+        }
+      controller = FooController.new
+      expect(controller).to respond_to(:index)
+      expect(controller).to respond_to(:other)
+    end
+
+    class FooContextBuilder
+      def bar(opts) {} end
+    end
+
+    class BazService
+      def qux(context) {} end
+    end
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'active_support/all'
+require 'action_controller'
+
+class ApplicationController < ActionController::Base
+end
+
+require_relative '../lib/ddc'
+

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: ddc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Shawn Anderson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.1'
+description: Use data to tell Rails how to interact with your domain.
+email:
+- shawn42@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ddc.gemspec
+- lib/ddc.rb
+- lib/ddc/controller_builder.rb
+- lib/ddc/response_builder.rb
+- lib/ddc/service_builder.rb
+- lib/ddc/version.rb
+- spec/controller_builder_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Data Driven Controllers for Rails
+test_files:
+- spec/controller_builder_spec.rb
+- spec/spec_helper.rb
+has_rdoc: