effective_resources 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25f7989cfcdf5345382d521f94331238f4ecd109
-  data.tar.gz: 0d2a3d92af2badd786a6d15da1e78daadaa5ffb9
+  metadata.gz: e0162b9865a0d7b0f8792b361f46f886c905286a
+  data.tar.gz: d3b8a389e8ff5e40860603aa22ed948bde07cc37
 SHA512:
-  metadata.gz: 3eb401a0edeef0cda4a3f8eddf9e409f30e8a4e643e62bfa70e8914a4d4f44b69eb20719872d254f96d7afdb98bae7dfb6be20492ba327e3d3d08c4c5c7d315f
-  data.tar.gz: 847044d382ea15c9b1a06786a09db78d82fe1d16636260d664d6d6f5afc90d2f1bb4a51fbada52b655f2516d719076ef21dfec73ec6a32bcbf0fcfa806fcc97c
+  metadata.gz: 7868a5dc8b09f78c1fd044878b9872e65a27e6698a8f52878d6a09a87dbde581c84a33b029d6d0c1869c2e362c24ab446c7b8e3d78ae95fd8e6f071d8c9786e1
+  data.tar.gz: 63eb662a68bb241d51b441dad12c2bcbba3cceaa8a04495e2fb868c56cb1aa441a64258ce347e69ccc268d98e7c08f16d345c906f954b92fa1a3e246d44daa07

data/README.md

@@ -6,8 +6,6 @@ Implements the 7 RESTful actions as a one-liner on any controller.
 
 ## Getting Started
 
-Add to your Gemfile:
-
 ```ruby
 gem 'effective_resources'
 ```
@@ -18,6 +16,14 @@ Run the bundle command to install it:
 bundle install
 ```
 
+Install the configuration file:
+
+```console
+rails generate effective_resources:install
+```
+
+The generator will install an initializer which describes all configuration options.
+
 ## Usage
 
 Add to your contoller:
@@ -26,6 +32,8 @@ Add to your contoller:
 class PostsController < ApplicationController
   include Effective::CrudController
 
+  member_action :something
+
   protected
 
   def post_scope
@@ -65,6 +73,18 @@ Call `simple_form_submit(f)` like follows:
 
 to render 3 submit buttons: `Save`, `Save and Continue`, and `Save and Add New`.
 
+### simple_form_save
+
+Call `simple_form_save(f)` like follows:
+
+```haml
+= simple_form_for(post) do |f|
+  ...
+  = simple_form_save(f)
+```
+
+to render just the `Save` button, with appropriate data-disable, title, etc.
+
 ## License
 
 MIT License.  Copyright [Code and Effect Inc.](http://www.codeandeffect.com/)

data/app/assets/javascripts/effective_resources.js

@@ -0,0 +1,2 @@
+//= require_tree ./effective_resources
+

data/app/assets/javascripts/effective_resources/effective_ujs.js

@@ -0,0 +1,85 @@
+;(function($, window, document, undefined) {
+  'use strict';
+
+  var defaults = {};
+
+  function EffectiveUjs(element, command, options) {
+    if(typeof(command) === 'string') { // Convert to camelCase
+      command = command.replace(/-([a-z])/g, function (str) { return str[1].toUpperCase(); });
+    }
+
+    if(typeof(this[command]) === 'function') {
+      this[command]($(element), $.extend({}, defaults, options));
+    }
+  }
+
+  $.extend(EffectiveUjs.prototype, {
+
+    // Converts all inputs to required fields
+    // $('#div-with-inputs').effective('inputs-required')
+    // $('input').effective('inputs-required')
+    inputsRequired: function(element, options) {
+      var elements = (element.first().is(':input') ? element : element.find('input,select,textarea'));
+
+      elements.each(function(index) {
+        var input = $(this);
+        var formGroup = input.closest('.form-group');
+
+        if(input.attr('type') == 'hidden') { return; }
+        if(input.hasClass('optional') && (input.attr('name') || '').indexOf('[address2]') > -1) { return; } // EffectiveAddresses
+
+        // Require the input
+        input.prop('required', true);
+
+        // Add the *
+        formGroup.find('abbr').remove();
+        input.parent().find('abbr').remove();
+
+        if(input.parent().is('label')) {
+          input.after("<abbr title='required'>*</abbr> ");
+        } else if(formGroup.length > 0) {
+          formGroup.find('label').prepend("<abbr title='required'>*</abbr> ");
+        } else {
+          input.parent().find('label').prepend("<abbr title='required'>*</abbr> ");
+        }
+
+        if(formGroup.length > 0) {
+          formGroup.removeClass('optional').addClass('required');
+          formGroup.find('.optional').removeClass('optional').addClass('required');
+        }
+      });
+    },
+
+    // Converts all inputs to non-required fields
+    // $('#div-with-inputs').effective('inputs-optional')
+    // $('input').effective('inputs-optional')
+    inputsOptional: function(element, options) {
+      var elements = (element.first().is(':input') ? element : element.find('input,select,textarea'));
+
+      elements.each(function(index) {
+        var input = $(this);
+        var formGroup = input.closest('.form-group');
+
+        if(input.attr('type') == 'hidden') { return; }
+
+        // Un-require the input
+        input.prop('required', false).removeAttr('required');
+
+        // Remove the *
+        formGroup.find('abbr').remove();
+        input.parent().find('abbr').remove();
+
+        if(formGroup.length > 0) {
+          formGroup.removeClass('required').addClass('optional');
+          formGroup.find('.required').removeClass('required').addClass('optional');
+        }
+      });
+    }
+
+  });
+
+  $.fn.effective = function(command, options) {
+    return this.each(function() { new EffectiveUjs(this, command, options); });
+  };
+
+})(jQuery, window, document);

data/app/controllers/concerns/effective/crud_controller.rb

@@ -6,6 +6,16 @@ module Effective
     end
 
     module ClassMethods
+      # Add the following to your controller for a simple member action
+      # member_action :print
+      def member_action(action)
+        define_method(action) do
+          self.resource ||= resource_class.find(params[:id])
+
+          @page_title ||= resource.to_s
+          EffectiveResources.authorized?(self, action, resource)
+        end
+      end
     end
 
     def index
@@ -114,6 +124,10 @@ module Effective
 
     private
 
+    def effective_resource
+      @_effective_resource ||= Effective::Resource.new(controller_path)
+    end
+
     def resource_name # 'thing'
       effective_resource.name
     end
@@ -167,11 +181,5 @@ module Effective
       effective_resource.index_path
     end
 
-    private
-
-    def effective_resource
-      @_effective_resource ||= Effective::Resource.new(controller_path)
-    end
-
   end
 end

data/app/helpers/effective_resources_helper.rb

@@ -1,18 +1,19 @@
 module EffectiveResourcesHelper
 
-  def simple_form_submit(form)
-    content_tag(:p, class: 'text-right') do
+  def simple_form_submit(form, options = {class: 'text-right'}, &block)
+    content_tag(:p, class: options[:class]) do
       [
         form.button(:submit, 'Save', data: { disable_with: 'Saving...' }),
         form.button(:submit, 'Save and Continue', data: { disable_with: 'Saving...' }),
-        form.button(:submit, 'Save and Add New', data: { disable_with: 'Saving...' })
-      ].join(' ').html_safe
+        form.button(:submit, 'Save and Add New', data: { disable_with: 'Saving...' }),
+        (capture(&block) if block_given?)
+      ].compact.join(' ').html_safe
     end
   end
 
-  def simple_form_save(form)
-    content_tag(:p, class: 'text-right') do
-      form.button(:submit, 'Save', data: { disable_with: 'Saving...' })
+  def simple_form_save(form, options = {class: 'text-right'}, &block)
+    content_tag(:p, class: options[:class]) do
+      form.button(:submit, 'Save', data: { disable_with: 'Saving...' }) + (capture(&:block) if block_given?)
     end
   end
 

data/app/models/effective/resource.rb

@@ -3,6 +3,7 @@ module Effective
     include Effective::Resources::Associations
     include Effective::Resources::Attributes
     include Effective::Resources::Init
+    include Effective::Resources::Instance
     include Effective::Resources::Klass
     include Effective::Resources::Naming
     include Effective::Resources::Paths

data/app/models/effective/resources/associations.rb

@@ -4,19 +4,22 @@ module Effective
 
       def belong_tos
         return [] unless klass.respond_to?(:reflect_on_all_associations)
-
         @belong_tos ||= klass.reflect_on_all_associations(:belongs_to)
       end
 
-      def nested_resources
-        return {} unless klass.respond_to?(:reflect_on_all_autosave_associations)
-
-        @nested ||= klass.reflect_on_all_autosave_associations.inject({}) do |hash, reference|
-          hash[reference] = Effective::Resource.new(reference); hash
-        end
+      def has_ones
+        return [] unless klass.respond_to?(:reflect_on_all_associations)
+        @has_ones ||= klass.reflect_on_all_associations(:has_one)
       end
 
       def has_manys
+        return [] unless klass.respond_to?(:reflect_on_all_associations)
+        @has_manys ||= klass.reflect_on_all_associations(:has_many).reject { |association| association.options[:autosave] }
+      end
+
+      def nested_resources
+        return [] unless klass.respond_to?(:reflect_on_all_associations)
+        @nested_resources ||= klass.reflect_on_all_associations(:has_many).select { |association| association.options[:autosave] }
       end
 
       def scopes

data/app/models/effective/resources/init.rb

@@ -4,8 +4,9 @@ module Effective
 
       private
 
-      def _initialize(input)
-        @input_name = _initialize_input_name(input)
+      def _initialize(obj)
+        @input_name = _initialize_input_name(obj)
+        @instance = obj if (klass && obj.instance_of?(klass))
       end
 
       def _initialize_input_name(input)
@@ -13,10 +14,11 @@ module Effective
         when String ; input
         when Symbol ; input
         when Class  ; input.name
-        when ActiveRecord::Reflection::MacroReflection ; input.name
+        when (ActiveRecord::Reflection::MacroReflection rescue false); input.name
+        when (ActionDispatch::Journey::Route rescue false); input.defaults[:controller]
         when nil    ; raise 'expected a string or class'
         else        ; input.class.name
-        end.to_s.downcase
+        end.to_s.underscore
       end
 
       # Lazy initialized

data/app/models/effective/resources/instance.rb

@@ -0,0 +1,55 @@
+module Effective
+  module Resources
+    module Instance
+      attr_reader :instance
+
+      # This is written for use by effective_logging and effective_trash
+
+      def instance_attributes
+        return {} unless instance.present?
+
+        attributes = { attributes: instance.attributes }
+
+        # Collect to_s representations of all belongs_to associations
+        belong_tos.each do |association|
+          attributes[association.name] = instance.send(association.name).to_s
+        end
+
+        has_ones.each do |association|
+          attributes[association.name] = instance.send(association.name).to_s
+        end
+
+        nested_resources.each do |association|
+          attributes[association.name] = {}
+
+          Array(instance.send(association.name)).each_with_index do |child, index|
+            resource = Effective::Resource.new(child)
+            attributes[association.name][index] = resource.instance_attributes
+          end
+        end
+
+        attributes.delete_if { |_, value| value.blank? }
+      end
+
+      def instance_changes
+        return {} unless instance.present?
+
+        changes = instance.changes
+
+        # Log to_s changes on all belongs_to associations
+        belong_tos.each do |association|
+          if (change = changes.delete(association.foreign_key)).present?
+            changes[association.name] = [(association.klass.find_by_id(change.first) if changes.first), instance.send(association.name)]
+          end
+        end
+
+        changes
+      end
+
+    end
+  end
+end
+
+
+
+

data/app/models/effective/resources/klass.rb

@@ -3,7 +3,11 @@ module Effective
     module Klass
 
       def klass
-        namespaced_class_name.safe_constantize || class_name.safe_constantize || name.safe_constantize
+        @model_klass ||= (
+          namespaced_class_name.safe_constantize ||
+          class_name.safe_constantize ||
+          name.classify.safe_constantize
+        )
       end
 
       def datatable_klass
@@ -17,6 +21,14 @@ module Effective
         end
       end
 
+      def controller_klass
+        @controller_klass ||= (
+          "#{namespaced_class_name.pluralize}Controller".safe_constantize ||
+          "#{class_name.pluralize.classify}Controller".safe_constantize ||
+          "#{name.pluralize.classify}Controller".safe_constantize
+        )
+      end
+
     end
   end
 end

data/lib/effective_resources/engine.rb

@@ -2,7 +2,7 @@ module EffectiveResources
   class Engine < ::Rails::Engine
     engine_name 'effective_resources'
 
-    config.autoload_paths += Dir["#{config.root}/lib/"]
+    config.autoload_paths += Dir["#{config.root}/lib/", "#{config.root}/app/controllers/concerns/effective/"]
 
     # Set up our default configuration options.
     initializer 'effective_resources.defaults', before: :load_config_initializers do |app|

data/lib/effective_resources/version.rb

@@ -1,3 +1,3 @@
 module EffectiveResources
-  VERSION = '0.2.1'.freeze
+  VERSION = '0.2.2'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_resources
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Code and Effect
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-26 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -33,6 +33,8 @@ extra_rdoc_files: []
 files:
 - MIT-LICENSE
 - README.md
+- app/assets/javascripts/effective_resources.js
+- app/assets/javascripts/effective_resources/effective_ujs.js
 - app/controllers/concerns/effective/crud_controller.rb
 - app/helpers/effective_resources_helper.rb
 - app/models/effective/access_denied.rb
@@ -42,6 +44,7 @@ files:
 - app/models/effective/resources/associations.rb
 - app/models/effective/resources/attributes.rb
 - app/models/effective/resources/init.rb
+- app/models/effective/resources/instance.rb
 - app/models/effective/resources/klass.rb
 - app/models/effective/resources/naming.rb
 - app/models/effective/resources/paths.rb