tila 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6f8a260763517d729f728c1d7598f246c99bdd8
+  data.tar.gz: 9b6b93fcc8be2b7deb4a4de95cdfbdb92966aa27
+SHA512:
+  metadata.gz: 0e9a4a1d61bd734ed8a8f3be2e4993f2567d46438d5139754afa2692842b42e291897ca6d6fc12166c1f94a28217884d03da07ac4324ed7582b7ddbbb146201c
+  data.tar.gz: d50ee02a1b6cf40467516809b51fb9d520cf63c0f045258242cf2fe122e629c01135d9912874107cd06e9b58ab854e1cef165532552b2f921e8eff1df813e79f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 Rolf van de Krol
+
+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,44 @@
+# Tila
+
+Most Rails projects contain a lot of controllers that are quite repetitive,
+because most controllers essentially what is needed to get a simple CRUD
+interface. This project contains components that can be used to build the 
+controller of this simple CRUD interface.
+
+Because Tila favors composition over inheritance, is allows for a flexibility
+that most other projects in this space don't have. If you only want to use a
+part of Tila, that works perfectly fine.
+
+## Components
+
+* __Actionable__: Provides an `action` helper so we can simply find out which
+  action is called and contains a list of actions that are operated on
+  collection and which actions are actions that save the model instance. It also
+  provides simple helpers to find out if the current action is in one of the
+  lists.
+* __Modelable__: Provides an `model` helper so we can access the model that the
+  controller is for, and a few helpers to access model name.
+* __Messages__: Provide a simple helper for generating message strings from
+  I18n. Requires _Modelable_.
+* __Objects__: Provides a simple accessor for `@object` and `@objects`. The
+  _ResourceLoaders_ component registers the loaded resources here.
+* __Params__: Provides a way to update the attributes of the object and simple
+  starting point for filtering out the permitted resource params. Requires
+  _Modelable_, _Objects_.
+* __SaveDestroy__: Provides the `save_object` and `destroy_object` methods.
+  Requires _Objects_.
+* __FormHandler__: Provides methods to handle the submit of forms and the
+  destroy. Requires _Messages_, _Objects_, _SaveDestroy_. You need to define a
+  `location_after_save` and a `location_after_destroy` method, if you want to
+  use this module in isolation. The _Resourceful_ component defines these
+  methods for you.
+* __ResourceLoaders__: Provides methods for loading the resources. Requires
+  _Modelable_ and _Objects_.
+* __ResourcefulUrls__: Generates the URLs to the controller. Requires 
+  _Modelable_.
+* __Resourceful__: Implements the actual controller actions, registers the 
+  _before_action_ to load the resources. This is the part that you want to
+  include when you want to enjoy the full glory of Tila. Requires _Actionable_,
+  _Params_, _FormHandler_, _ResourceLoaders_ and _ResourcefulUrls_.
+
+

data/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Tila'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/tasks/tila_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :tila do
+#   # Task goes here
+# end

data/lib/tila.rb

@@ -0,0 +1,14 @@
+module Tila
+  autoload :Actionable, 'tila/actionable'
+  autoload :Modelable,  'tila/modelable'
+  autoload :Messages, 'tila/messages'
+  autoload :Objects, 'tila/objects'
+  autoload :Params, 'tila/params'
+
+  autoload :SaveDestroy, 'tila/save_destroy'
+  autoload :FormHandler, 'tila/form_handler'
+  
+  autoload :ResourceLoaders, 'tila/resource_loaders'
+  autoload :ResourcefulUrls, 'tila/resourceful_urls'
+  autoload :Resourceful, 'tila/resourceful'
+end

data/lib/tila/actionable.rb

@@ -0,0 +1,43 @@
+module Tila
+  module Actionable
+    extend ActiveSupport::Concern
+
+    included do
+      helper_method :action
+    end
+
+    class_methods do
+      def collection_actions
+        [:index]
+      end
+
+      def new_actions
+        [:new, :create]
+      end
+
+      def save_actions
+        [:create, :update]
+      end
+    end
+
+    protected
+
+    def action
+      params[:action].to_sym
+    end
+
+    def collection_action?
+      self.class.collection_actions.include? action
+    end
+    def new_action?
+      self.class.new_actions.include? action
+    end
+    def save_action?
+      self.class.save_actions.include? action
+    end
+
+    def member_action?
+      !collection_action?
+    end
+  end
+end

data/lib/tila/form_handler.rb

@@ -0,0 +1,31 @@
+module Tila
+  module FormHandler
+    extend ActiveSupport::Concern
+    include Messages
+    include Objects
+    include SaveDestroy
+
+    protected
+
+    def handle_form(error_view, message_key)
+      respond_to do |format|
+        if save_object
+          format.html { redirect_to location_after_save, notice: message(message_key) }
+          format.json { render :show, status: :created, location: object }
+        else
+          format.html { render error_view }
+          format.json { render json: object.errors, status: :unprocessable_entity }
+        end
+      end
+    end
+
+    def handle_destroy(message_key)
+      destroy_object
+
+      respond_to do |format|
+        format.html { redirect_to location_after_destroy, notice: message(message_key) }
+        format.json { head :no_content }
+      end
+    end
+  end
+end

data/lib/tila/messages.rb

@@ -0,0 +1,12 @@
+module Tila
+  module Messages
+    extend ActiveSupport::Concern
+    include Modelable
+
+    protected
+    
+    def message(message_key)
+      t(message_key, scope: [:activerecord, :messages, model_name])
+    end
+  end
+end

data/lib/tila/modelable.rb

@@ -0,0 +1,28 @@
+module Tila
+  module Modelable
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def model
+        @model ||= controller_path.singularize.camelize.constantize
+      end
+    end
+
+    protected
+
+    def model
+      self.class.model
+    end
+
+    def object_name
+      self.class.model.model_name.element
+    end
+    def objects_name
+      object_name.pluralize
+    end
+
+    def model_name
+      model.model_name.singular
+    end
+  end
+end

data/lib/tila/objects.rb

@@ -0,0 +1,10 @@
+module Tila
+  module Objects
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :object, :collection
+      helper_method :object, :collection
+    end
+  end
+end

data/lib/tila/params.rb

@@ -0,0 +1,21 @@
+module Tila
+  module Params
+    extend ActiveSupport::Concern
+    include Modelable
+    include Objects
+
+    protected
+
+    def update_resource_params
+      object.attributes = permitted_resource_params
+    end
+
+    def permitted_resource_params
+      raise "The permitted_resource_params method should be overriden"
+    end
+
+    def resource_params
+      params.require(object_name)
+    end
+  end
+end

data/lib/tila/resource_loaders.rb

@@ -0,0 +1,43 @@
+module Tila
+  module ResourceLoaders
+    extend ActiveSupport::Concern
+    include Modelable
+    include Objects
+
+    protected
+
+    def resource_base
+      model
+    end
+
+    def load_resource
+      if member_action?
+        self.object ||= load_resource_instance
+        instance_variable_set("@#{object_name}", object)
+      else
+        self.collection ||= load_collection
+        instance_variable_set("@#{objects_name}", collection)
+      end
+    end
+
+    def load_resource_instance
+      if new_action?
+        build_resource
+      elsif params[:id]
+        find_resource
+      end
+    end
+
+    def find_resource
+      resource_base.find(params[:id])
+    end
+
+    def build_resource
+      resource_base.new
+    end
+
+    def load_collection
+      resource_base.where(nil)
+    end
+  end
+end

data/lib/tila/resourceful.rb

@@ -0,0 +1,42 @@
+module Tila
+  module Resourceful
+    extend ActiveSupport::Concern
+    include Actionable
+    include Params
+    include FormHandler
+    include ResourceLoaders
+    include ResourcefulUrls
+
+    included do
+      before_action :load_resource
+      before_action :update_resource_params, only: save_actions
+    end
+
+    def index; end
+    def show;  end
+    def new;   end
+    def edit;  end
+
+    def create
+      handle_form :new, :created
+    end
+
+    def update
+      handle_form :edit, :updated
+    end
+
+    def destroy
+      handle_destroy :destroyed
+    end
+
+    protected
+
+    def location_after_save
+      object_url
+    end
+
+    def location_after_destroy
+      collection_url
+    end
+  end
+end

data/lib/tila/resourceful_urls.rb

@@ -0,0 +1,22 @@
+module Tila
+  module ResourcefulUrls
+    extend ActiveSupport::Concern
+    include Modelable
+
+    included do
+      helper_method :object_url, :collection_url
+    end
+
+    protected
+
+    def object_url(object = nil, options = {})
+      target = object ? object : self.object
+
+      send "#{model.model_name.route_key.singularize}_url", target, options
+    end
+
+    def collection_url(options = {})
+      send "#{model.model_name.route_key}_url", options
+    end
+  end
+end

data/lib/tila/save_destroy.rb

@@ -0,0 +1,14 @@
+module Tila
+  module SaveDestroy
+    extend ActiveSupport::Concern
+    include Objects
+
+    def save_object
+      object.save
+    end
+
+    def destroy_object
+      object.destroy
+    end
+  end
+end

data/lib/tila/version.rb

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

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.