fae-rails 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 434487251ad2bd07e41ff038a09c1348812b25d6
-  data.tar.gz: 17f57e68dc8f5f3441015c12c1a32b00389e7c96
+  metadata.gz: 5d574cc1fbcb62791659320a0f2f206fbeaf7d64
+  data.tar.gz: d49ec0ff00d9f93114ae825cbe829b4d94ea6c1c
 SHA512:
-  metadata.gz: 4d7c2bd09329d2c856e6255bbb85fef36cbf7b088a219bdf376d6c85ec5a8e65a303f9fe9c763a6d29b817d3b55af6cd83aa944fe7965ccd286bcfed3157a1ae
-  data.tar.gz: f3c25f59d11e7de21836726290f69bc800c17db9e115dfdf51a8670e4bd53bc9469821150c8ac0aebb36e55b6fb81745fb8bd6760730a36ed27c69632e7ec708
+  metadata.gz: 85469dbf3f1df0da3247fb22f41d844c9e12275f9f10e57f724a3125597c7d5ca80433d48fc634762edca9a52df8f5de856f197c824f9f6a2e13fe824b673d93
+  data.tar.gz: 8653abcc2fa67d31be7c435071f8a6ef5baebb0fd38bf18d75428695bd7a36984a556a3e03de39c50f2d65a096f331c1e1b2cda40de02b22845fde6e6f15cb31

data/README.md

@@ -6,24 +6,97 @@
 
 Fae is CMS for Rails unlike any other. Like most Rails CMS engines, Fae provides all the basics to get you up and running: authentication, a responsive UI, form element and workflows. But unlike other CMS engines, Fae's methodology is based around generators and a DSL over configuration. This allows you to get to a working CMS very quickly, but gives you the flexibility to customize any piece you need.
 
-Fae requires Rails >= 4.1.
+## Installation
+
+Add the gem to your Gemfile and run `bundle install`
+
+```ruby
+gem 'fae-rails'
+```
+Run the installer
+
+```bash
+$ rails g fae:install
+```
+
+After the installer completes, visit `/admin` and setup your first user account. That should automatically log you in to your blank Fae instance.
+
+### Dependencies
+
+#### Rails
+
+Fae supports Rails >= 4.1.
+
+#### Sass and sass-rails
+
+Fae requires `sass >= 3.4` and `sass-rails >= 5`.
+
+If you're using Rails 4.1 you'll need to update the versions in the `Gemfile`:
+
+```ruby
+gem 'sass-rails', '~> 5.0.0'
+gem 'sass', '~> 3.4.0'
+```
+
+and run:
+
+```bash
+$ bundle update sass-rails
+$ bundle update sass
+```
 
 ## Documentation
 
-* [Installation](docs/index.md)
-* [Usage](docs/usage.md)
-* [Customization](docs/customization.md)
-* [Form and View Helpers](docs/helpers.md)
-* [Upgrading Guide](docs/upgrading.md)
-* [Changelog](CHANGELOG.md)
-* [Contributing and Maintenance](CONTRIBUTING.md)
+### Topics
+
+* [Installation](docs/installation/index.md)
+* [Generators](docs/topics/generators.md)
+* [Navigation Setup](docs/topics/navigation_setup.md)
+* [Initializer](docs/topics/initializer.md)
+* [Models](docs/topics/models.md)
+* [Controllers](docs/topics/controllers_and_concerns.md)
+* [Fae Model and Controller Concerns](docs/topics/concerns.md)
+* [Override Uploaders and Classes](docs/topics/override_uploaders_and_classes.md)
+* [Pages and Content Blocks](docs/topics/pages.md)
+* [Custom JS, CSS and Helpers](docs/topics/custom_js_css.md)
+* [Root Settings](docs/topics/root_settings.md)
+
+
+### Features
+
+* [Global Search](docs/features/search.md)
+* [Filtering](docs/features/filtering.md)
+* [Multi-Language Support](docs/features/multi_language.md)
+* [Cloning](docs/features/cloning.md)
+* [Change Tracker](docs/features/change_tracker.md)
+* [Slugger](docs/features/slugger.md)
+* [Disabling Environments](docs/features/disable_envs.md)
+
+
+### Tutorials
+
+* [Adding Conditional Validations](docs/tutorials/conditional_validations.md)
+* [Custom Image Processing](docs/tutorials/custom_images.md)
+* [Overriding The Landing Page](docs/tutorials/landing_page.md)
+* [Devise Action Mailer Configuration](docs/tutorials/actionmailer.md)
+
 
-## License
+### Helper/DSL Docs
 
-[MIT](LICENSE)
+* [Fae Styles](docs/helpers/styles.md)
+* [Form Helpers](docs/helpers/form_helpers.md)
+* [Nested Form Helpers](docs/helpers/nested_form_helpers.md)
+* [View Helpers](docs/helpers/view_helpers.md)
+* [Fae Partials](docs/helpers/partials.md)
 
+### Contributing
 
+* [Running Fae Locally](docs/contributing/local_setup.md)
+* [Fae Standards](docs/contributing/standards.md)
 
+## [Upgrading](docs/upgrading/index.md)
 
+## [Changelog](CHANGELOG.md)
 
+## [MIT License](LICENSE)
 

data/app/assets/javascripts/fae/_tables.js

@@ -372,7 +372,7 @@ Fae.tables = {
       $fixed_header.css({
         width: $this.outerWidth(),
         height: thead_height,
-        top: header_height,
+        top: header_height
       });
     }
 

data/app/assets/javascripts/fae/form/_ajax.js

@@ -370,7 +370,11 @@ Fae.form.ajax = {
 
       // The settings menu for tables and checkboxes
       .on('click', '.boolean label, .js-checkbox-wrapper label', function(e){
-        $(this).toggleClass('active');
+        var $this = $(this);
+
+        if(!$this.hasClass('disabled') && !$this.hasClass('readonly')) {
+          $this.toggleClass('active');
+        }
       })
 
       // stop the event bubbling and running the above toggleClass twice

data/app/assets/javascripts/fae/form/fileinputer.js

@@ -144,6 +144,9 @@
 
       return false;
     } else {
+      this.$input.next('.error').remove();
+      this.$el.removeClass('field_with_errors');
+
       return true;
     }
   };

data/app/assets/javascripts/fae/form/inputs/_select.js

@@ -7,11 +7,7 @@
  */
 Fae.form.select = {
 
-  availableItemsStr: ' Available Items',
-  addedItemsStr: ' Added Items',
-
   init: function() {
-    this.selectableText();
     this.multiselectOrChosen();
   },
 
@@ -20,6 +16,18 @@ Fae.form.select = {
    */
   multiselectOrChosen: function() {
     var _this = this;
+    var availableItemsStr = ' Available Items';
+    var addedItemsStr = ' Added Items';
+
+    /**
+     * On selection change, update items left and currently added
+     * @private
+     */
+    function updateMultiselectHeader() {
+      var $instance = $(this)[0];
+      $('.ms-selectable .custom-header').text( $instance.$selectableContainer.find($instance.elemsSelector).length + availableItemsStr);
+      $('.ms-selection .custom-header').text( $instance.$selectionContainer.find($instance.elemsSelector).length + addedItemsStr);
+    }
 
     $('select').each(function(index, elm){
       var $this = $(this);
@@ -27,40 +35,26 @@ Fae.form.select = {
       if ($this.hasClass('multiselect')) {
         $this.multiSelect({
           selectableHeader: '<div class="custom-header"></div>',
-          selectionHeader: '<div class="custom-header"></div>'
+          selectionHeader: '<div class="custom-header"></div>',
+          afterSelect: function(values) {
+            updateMultiselectHeader.call(this);
+          },
+          afterDeselect: function(values) {
+            updateMultiselectHeader.call(this);
+          }
         });
 
         var selectableCount = $this.next('.ms-container').find('.ms-selectable li').not('.ms-selected').length
         var selectedCount = $this.next('.ms-container').find('.ms-selection .ms-selected').length;
 
-        $('.ms-selectable .custom-header').text(selectableCount + _this.availableItemsStr);
-        $('.ms-selection .custom-header').text(selectedCount + _this.addedItemsStr);
+        $('.ms-selectable .custom-header').text(selectableCount + availableItemsStr);
+        $('.ms-selection .custom-header').text(selectedCount + addedItemsStr);
 
       } else {
         $this.fae_chosen();
 
       }
     });
-  },
-
-  /**
-   * On selection change, update items left and currently added
-   */
-  selectableText: function() {
-    var _this = this;
-    var $selectable = $('.ms-selectable .custom-header');
-    var $selection = $('.ms-selection .custom-header');
-
-    $('.ms-selectable li').on('click', function(){
-      $selectable.text( (parseInt($selectable.text()) - 1) + _this.availableItemsStr );
-      $selection.text( (parseInt($selection.text()) + 1) + _this.addedItemsStr );
-    });
-
-    $('.ms-selection li').on('click', function(){
-      $selectable.text( (parseInt($selectable.text()) + 1) + _this.availableItemsStr );
-      $selection.text( (parseInt($selection.text()) - 1) + _this.addedItemsStr );
-    });
-
   }
 
 };

data/app/assets/javascripts/fae/navigation/sticky.js

@@ -3,6 +3,17 @@
 (function ( $ ) {
   'use strict';
 
+  /**
+   * Adjust offsets
+   * @private
+   * @param {jQuery} $el
+   * @see Sticky.windowListeners
+   */
+  function setDimensionsTopLeft($el) {
+    this.dimensions.top = $el.offset().top - this.options.offset;
+    this.dimensions.left = $el.offset().left;
+  }
+
   /**
    * Private initialization of Sticky object.
    * @class
@@ -130,13 +141,9 @@
 
     function debounceResizeCallback() {
       if ( _this.$placeholder && _this.$placeholder.is(':visible')) {
-        _this.dimensions.top = _this.$placeholder.offset().top - _this.options.offset;
-        _this.dimensions.left = _this.$placeholder.offset().left;
-
+        setDimensionsTopLeft.call(_this, _this.$placeholder);
       } else {
-        _this.dimensions.top = _this.$el.offset().top - _this.options.offset;
-        _this.dimensions.left = _this.$el.offset().left;
-
+        setDimensionsTopLeft.call(_this, _this.$el);
       }
 
       _this.stickIt();

data/app/assets/stylesheets/fae/modules/forms/_base.scss

@@ -20,6 +20,10 @@ input[type=email] {
 
 .input {
   margin-bottom: 20px;
+
+  &.disabled {
+    opacity: 0.5;
+  }
 }
 
 .addedit-form {

data/app/assets/stylesheets/fae/modules/forms/_select.scss

@@ -181,7 +181,6 @@
         font-size: 13px;
 
         &:after {
-          content: "Add";
           position: absolute;
           right: 15px;
           top: 9px;
@@ -189,6 +188,12 @@
         }
       }
 
+      &.ms-elem-selectable {
+        &:after {
+          content: "Add";
+        }
+      }
+
       &.ms-hover {
         cursor: pointer;
         text-decoration: none;

data/app/controllers/fae/base_controller.rb

@@ -78,12 +78,12 @@ module Fae
       @new_path = @index_path + '/new'                     # used in index_header partial
     end
 
-    # Use callbacks to share common setup or constraints between actions.
+    # use callbacks to share common setup or constraints between actions.
     def set_item
       @item = @klass.find(params[:id])
     end
 
-    # Only allow a trusted parameter "white list" through.
+    # only allow trusted parameters, override to white-list
     def item_params
       params.require(@klass_singular).permit!
     end

data/app/controllers/fae/nested_base_controller.rb

@@ -0,0 +1,100 @@
+module Fae
+  class NestedBaseController < Fae::ApplicationController
+
+    before_action :set_class_variables
+    before_action :set_item, only: [:show, :edit, :update, :destroy]
+
+    layout false, except: :index
+    helper Fae::ApplicationHelper
+
+    def new
+      @item = @klass.new
+      raise_undefined_parent if @item.fae_nested_foreign_key.blank?
+
+      item_id = params[:item_id].to_i || nil
+      @item.send("#{parent_foreign_key}=", item_id)
+      build_assets
+    end
+
+    def edit
+      build_assets
+    end
+
+    def create
+      @item = @klass.new(permitted_params)
+      raise_undefined_parent if @item.fae_nested_parent.blank?
+
+      if @item.save
+        @parent_item = @item.send(nested_parent)
+        flash[:notice] = t('fae.save_notice')
+        render template: table_template_path
+      else
+        build_assets
+        render action: 'new'
+      end
+    end
+
+    def update
+      raise_undefined_parent if @item.fae_nested_parent.blank?
+
+      if @item.update(permitted_params)
+        @parent_item = @item.send(nested_parent)
+        flash[:notice] = t('fae.save_notice')
+        render template: table_template_path
+      else
+        build_assets
+        render action: 'edit'
+      end
+    end
+
+    def destroy
+      raise_undefined_parent if @item.fae_nested_parent.blank?
+      @parent_item = @item.send(nested_parent)
+
+      if @item.destroy
+        flash[:notice] = t('fae.delete_notice')
+      else
+        flash[:alert] = t('fae.delete_error')
+      end
+      render template: table_template_path
+    end
+
+    private
+
+    def set_class_variables
+      @klass_name = params[:controller].split('/').last
+      @klass = @klass_name.classify.constantize
+      @klass_singular = @klass_name.singularize
+    end
+
+    def set_item
+      @item = @klass.find(params[:id])
+    end
+
+    # only allow trusted parameters, override to white-list
+    def permitted_params
+      params.require(@klass_singular).permit!
+    end
+
+    # if model has images or files, build them here for nesting
+    def build_assets
+    end
+
+    def raise_undefined_parent
+      raise "Define `fae_nested_parent` as a instance method of #{@klass.name}"
+    end
+
+    def table_template_path
+      "#{fae.root_path.gsub('/', '')}/#{@klass_name}/table"
+    end
+
+    def parent_foreign_key
+      @item.fae_nested_foreign_key
+    end
+
+    def nested_parent
+      @item.fae_nested_parent
+    end
+
+  end
+end

data/app/models/concerns/fae/base_model_concern.rb

@@ -9,6 +9,15 @@ module Fae
       include Fae::Trackable if Fae.track_changes
     end
 
+    def fae_nested_parent
+      # override this method in your model
+    end
+
+    def fae_nested_foreign_key
+      return if fae_nested_parent.blank?
+      "#{fae_nested_parent}_id"
+    end
+
     module ClassMethods
       def fae_display_field
         # override this method in your model
@@ -42,7 +51,7 @@ module Fae
       end
 
       def fae_search(query)
-        all.to_a.keep_if { |i| i.fae_display_field.present? && i.fae_display_field.downcase.include?(query.downcase) }
+        all.to_a.keep_if { |i| i.fae_display_field.present? && i.fae_display_field.to_s.downcase.include?(query.downcase) }
       end
 
       def to_csv
@@ -54,6 +63,18 @@ module Fae
         end
       end
 
+      def translate(*attributes)
+        attributes.each do |attribute|
+          define_method attribute.to_s do
+            self.send "#{attribute}_#{I18n.locale}"
+          end
+
+          define_singleton_method "find_by_#{attribute}" do |val|
+            self.send("find_by_#{attribute}_#{I18n.locale}", val)
+          end
+        end
+      end
+
     end
   end
 end