bhf 0.10.10 → 0.10.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e72206abf7fb55fa9fb492f9c5a003e8164c54a9
-  data.tar.gz: 658abe68ef47bf273f1e70e170f7806c1250140b
+  metadata.gz: 4071d3ba1e9675e801868438caa4051e4c5ef429
+  data.tar.gz: 0f7ecb7934ffbd40970a2f1d2f5afafdd53be10b
 SHA512:
-  metadata.gz: b7b7647df5a2d86dcda1b05544362ed377f3426e364e82e1a76fd1d81f019034a242176d76df84d72652ebf0271a00a0fe334ad68f1005b6998327b1995d12d6
-  data.tar.gz: 0f22a0f775f1a61b6e64da56cb1cb520e5a2ff1379fa7e138d4f02618b68b410e0a14f0ca8da7759f0bf69922cd75a44a92cba3987d681f43cb5e12cc5396322
+  metadata.gz: c813183af40bc6b0a37f7f2fd3b555558518148679470ec6dec1e95335d5977d435b6050de6c8a0af1f3576b2d8fefb9baec8abaf09e887ea2cab0dee0ef9dcd
+  data.tar.gz: 19a590d3458fa1ea84ce4de5434c048a7aa77d82b69fac2ca34a12df74d2729163593ab705f94c4aadb71b850b107eac89811dfe16646d60a6edde2756f9bdb4

data/Getting_Started.md

@@ -0,0 +1,16 @@
+### Setup user authentication
+
+Along with the standard approach in authentication, instead of defining the `#login` action in the
+`Admin` controller, you are able to redefine `Bhf::ApplicationController`, and its `#check_admin_account` 
+method, to give to `Bhf` the knowledge about weither current user is admin or not. Do it like follows:
+
+    class Bhf::ApplicationController < ActionController::Base
+      protect_from_forgery
+      before_filter :authenticate_user! # if devise authentication is used
+      include Bhf::Extension::ApplicationController
+
+      def check_admin_account
+        current_user.is_admin? # Here expression must be evaluated to `true` if user is admin.
+      end
+    end
+

data/README.md

@@ -2,6 +2,8 @@
 
 ## [Guide and Documentation](http://antpaw.github.io/bhf/)
 
+Also see [Getting Started](Getting_Started.md) document for additional info.
+
 ## Contributing to bhf
 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.

data/VERSION

@@ -1 +1 @@
-0.10.10
+0.10.11

data/app/assets/javascripts/bhf/application.js

@@ -36,6 +36,7 @@ Turbolinks.pagesCached(0);
 					setTimeout(function(){
 						rowElem.removeClass('animate');
 					}, 600);
+					linkElem = rowElem;
 				}
 				setTimeout(function(){
 					linkElem.removeClass('live_edit');

data/app/controllers/bhf/application_controller.rb

@@ -1,103 +1,4 @@
 class Bhf::ApplicationController < ActionController::Base
-
-  before_filter :init_time, :check_admin_account, :setup_current_account, :load_settings, :set_title, :set_areas
-
-  helper_method :current_account
-  layout 'bhf/application'
-
-  def index
-    
-  end
-
-  private
-
-    def check_admin_account
-      if session[Bhf.configuration.session_auth_name.to_s] == true
-        return true
-      end
-      redirect_to(main_app.send(Bhf.configuration.on_login_fail.to_sym), error: t('bhf.helpers.user.login.error')) and return false
-    end
-
-    def setup_current_account
-      if session[Bhf.configuration.session_account_id]
-        @current_account = Bhf.configuration.account_model.classify.constantize.send(
-          Bhf.configuration.account_model_find_method.to_sym,
-          session[Bhf.configuration.session_account_id.to_s]
-        )
-        # => User.find(current_account.id)
-      end
-    end
-
-    def current_account
-      @current_account
-    end
-
-    def get_account_roles(area = nil)
-      return unless current_account
-
-      if area
-        if current_account.respond_to?(:bhf_area_roles)
-          return current_account.bhf_area_roles(area).collect(&:identifier)
-        end
-      end
-
-      if current_account.respond_to?(:bhf_roles)
-        current_account.bhf_roles.collect(&:identifier)
-      end
-    end
-
-    def load_settings
-      yaml_parser = Bhf::Settings::YAMLParser.new(get_account_roles(params[:bhf_area]), params[:bhf_area])
-      @settings = Bhf::Settings::Base.new(yaml_parser.settings_hash, current_account)
-    end
-
-    def set_title
-      @app_title = Rails.application.class.to_s.split('::').first
-
-      @title = if params[:bhf_area]
-        t("bhf.areas.page_title.#{params[:bhf_area]}", 
-          area: params[:bhf_area],
-          title: @app_title,
-          default: t('bhf.areas.page_title', 
-            title: @app_title,
-            area: t("bhf.areas.links.#{params[:bhf_area]}", default: params[:bhf_area])
-          )
-        )
-      else
-        t('bhf.page_title', title: @app_title)
-      end.html_safe
-    end
-
-    def set_areas
-      @areas = []
-      if current_account and current_account.respond_to?(:bhf_areas)
-        current_account.bhf_areas.each do |area|
-          selected = params[:bhf_area] == area.identifier
-          @areas << OpenStruct.new(
-            name: area.to_bhf_s,
-            selected: selected,
-            path: main_app.bhf_path(area.identifier)
-          )
-          @root_link = area.link if selected
-        end
-      end
-    end
-
-    def set_message(type, model = nil)
-      key = model && ActiveModel::Naming.singular(model)
-      I18n.t("bhf.activerecord.notices.models.#{key}.#{type}", model: model.model_name.human, default: I18n.t("activerecord.notices.messages.#{type}"))
-    end
-
-    def init_time
-      @start_time = Time.now
-    end
-
-    def find_platform(platform_name)
-      Bhf::Platform::Base.new(@settings.find_platform_settings(platform_name))
-    end
-
-    def redirect_back_or_default(default, msg)
-      redirect_to(params[:return_to] || default, flash: msg)
-    end
-
+  include Bhf::Extension::ApplicationController
+  protect_from_forgery
 end

data/app/helpers/bhf/application_helper.rb

@@ -2,23 +2,23 @@ module Bhf
   module ApplicationHelper
 
     def show_t(platform)
-      t("bhf.helpers.entry.models.#{platform.model_name}.show", platform_title: platform.title_singular, default: t('bhf.helpers.entry.show')).html_safe
+      t("bhf.helpers.entry.models.#{platform.model_name}.show", platform_title: platform.title_singular.titleize, default: t('bhf.helpers.entry.show')).html_safe
     end
 
     def new_t(platform)
-      t("bhf.helpers.entry.models.#{platform.model_name}.new", platform_title: platform.title_singular, default: t('bhf.helpers.entry.new')).html_safe
+      t("bhf.helpers.entry.models.#{platform.model_name}.new", platform_title: platform.title_singular.titleize, default: t('bhf.helpers.entry.new')).html_safe
     end
 
     def duplicate_t(platform)
-      t("bhf.helpers.entry.models.#{platform.model_name}.duplicate", platform_title: platform.title_singular, default: t('bhf.helpers.entry.duplicate')).html_safe
+      t("bhf.helpers.entry.models.#{platform.model_name}.duplicate", platform_title: platform.title_singular.titleize, default: t('bhf.helpers.entry.duplicate')).html_safe
     end
 
     def edit_t(platform)
-      t("bhf.helpers.entry.models.#{platform.model_name}.edit", platform_title: platform.title_singular, default: t('bhf.helpers.entry.edit')).html_safe
+      t("bhf.helpers.entry.models.#{platform.model_name}.edit", platform_title: platform.title_singular.titleize, default: t('bhf.helpers.entry.edit')).html_safe
     end
 
     def delete_t(platform)
-      t("bhf.helpers.entry.models.#{platform.model_name}.delete", platform_title: platform.title_singular, default: t('bhf.helpers.entry.delete')).html_safe
+      t("bhf.helpers.entry.models.#{platform.model_name}.delete", platform_title: platform.title_singular.titleize, default: t('bhf.helpers.entry.delete')).html_safe
     end
     
     def find_smallest_size_url_for_file(file)
@@ -36,4 +36,4 @@ module Bhf
     end
     
   end
-end
+end

data/app/views/bhf/application/index.html.haml

@@ -1,4 +1,4 @@
 .content_box
   %ul.basic_info_list
     - @settings.pages.each do |page|
-      %li= link_to t("bhf.pages.navigation.#{page}", default: page.capitalize), page_path(page)
+      %li= link_to t("bhf.pages.navigation.#{page}", default: page.titleize), page_path(page)

data/app/views/bhf/pages/_platform.html.haml

@@ -10,7 +10,7 @@
   - local_names = [:column_value, :object, :link, :add_quick_link]
   %table.data_table{id: "#{platform.name}_platform", class: (platform.custom_columns? ? :custom_columns : :default_columns)}
     %caption
-      %h4= platform.title
+      %h4= platform.title.titleize
       - unless platform.hide_create
         %p.create= link_to new_t(platform), new_entry_path(platform.name), class: :alt_button
       - unless platform.custom_partial
@@ -22,7 +22,7 @@
           %th.drag
         - platform.columns.each do |column|
           %th{class: "#{column.macro} #{column.display_type} #{order_class(column.db_name, platform.name)}"}
-            = link_to_if column.reorderble, column.title, current_order_path(column.db_name, platform.name)
+            = link_to_if column.reorderble, column.title.titleize, current_order_path(column.db_name, platform.name)
         %th.action
 
     %tfoot
@@ -69,15 +69,15 @@
               - unless platform.hide_edit
                 = link_to edit_t(platform), edit_link, class: 'icon edit'
               - unless platform.hide_delete
-                = link_to delete_t(platform), entry_path(platform.name, object), method: :delete, remote: true, class: 'icon delete js_delete', data: {confirm: t('bhf.helpers.promts.confirm', platform_title: platform.title_singular)}
+                = link_to delete_t(platform), entry_path(platform.name, object), method: :delete, remote: true, class: 'icon delete js_delete', data: {confirm: t('bhf.helpers.promts.confirm', platform_title: platform.title_singular.titleize)}
       - else
         %td.no_entries{colspan: platform.columns_count}
-          = t 'bhf.pagination.info', name_zero: platform.title, count: 0
+          = t 'bhf.pagination.info', name_zero: platform.title.titleize, count: 0
           - unless platform.hide_create
             = link_to new_t(platform), new_entry_path(platform.name)
 
       - if platform.table_quick_edit
-        .quick_edit_template{type: 'text/template'}
+        %template.quick_edit_template{type: 'text/template'}
           %tr.quick_edit_entry{id: "{object_id}_#{platform.name}"}
             - edit_link = edit_entry_path(platform.name, '{object_id}')
             - if platform.sortable
@@ -96,4 +96,4 @@
               - unless platform.hide_edit
                 = link_to edit_t(platform), edit_link, class: 'icon edit'
               - unless platform.hide_delete
-                = link_to delete_t(platform), entry_path(platform.name, '{object_id}'), method: :delete, remote: true, class: 'icon delete js_delete', data: {confirm: t('bhf.helpers.promts.confirm', platform_title: platform.title_singular)}
+                = link_to delete_t(platform), entry_path(platform.name, '{object_id}'), method: :delete, remote: true, class: 'icon delete js_delete', data: {confirm: t('bhf.helpers.promts.confirm', platform_title: platform.title_singular.titleize)}

data/app/views/layouts/bhf/application.haml

@@ -26,7 +26,7 @@
           %ul{class: ('shrink_space' if @settings.pages.count > 7)}
             - @settings.pages.each do |page|
               %li{class: ('active' if @page == page)}
-                = link_to t("bhf.pages.navigation.#{page}", default: page.capitalize), page_path(page)
+                = link_to t("bhf.pages.navigation.#{page}", default: page.titleize), page_path(page)
 
     #content
       #main

data/bhf.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: bhf 0.10.10 ruby lib
+# stub: bhf 0.10.11 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "bhf"
-  s.version = "0.10.10"
+  s.version = "0.10.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib"]
   s.authors = ["Anton Pawlik"]
-  s.date = "2015-04-18"
+  s.date = "2015-10-02"
   s.description = "A simple to use Rails-Engine-Gem that offers an admin interface for trusted user. Easy integratable and highly configurable and agnostic. Works with ActiveRecord and Mongoid."
   s.email = "anton.pawlik@gmail.com"
   s.extra_rdoc_files = [
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.files = [
     "Gemfile",
     "Gemfile.lock",
+    "Getting_Started.md",
     "LICENSE.txt",
     "README.md",
     "Rakefile",
@@ -146,6 +147,7 @@ Gem::Specification.new do |s|
     "lib/bhf/action_view/form_builder.rb",
     "lib/bhf/action_view/form_options.rb",
     "lib/bhf/active_record/base.rb",
+    "lib/bhf/controller/extension.rb",
     "lib/bhf/mongoid/document.rb",
     "lib/bhf/platform/attribute/abstract.rb",
     "lib/bhf/platform/attribute/column.rb",

data/lib/bhf.rb

@@ -44,7 +44,8 @@ module Bhf
     config_accessor(:js)                        { ['bhf/application'] }
     config_accessor(:abstract_settings)         { []                  }
     config_accessor(:paperclip_image_types)     {
-      ['image/jpeg', 'image/pjpeg', 'image/jpg', 'image/png', 'image/tif', 'image/gif']
+      ['image/jpeg', 'image/pjpeg', 'image/jpg', 'image/png',
+       'image/tif', 'image/gif']
     }
   end
 end
@@ -61,3 +62,4 @@ require 'bhf/active_record/base'
 require 'bhf/mongoid/document'
 require 'bhf/action_view/form_options'
 require 'bhf/action_view/form_builder'
+require 'bhf/controller/extension'

data/lib/bhf/controller/extension.rb

@@ -0,0 +1,122 @@
+module Bhf
+  module Extension
+    module ApplicationController
+      extend ActiveSupport::Concern
+
+      included do
+        include Instance
+
+        before_filter :init_time
+        before_filter :check_admin_account, :setup_current_account,
+          :load_settings, :set_title, :set_areas
+
+        helper_method :current_account
+        layout 'bhf/application'
+      end
+
+      module Instance
+        def index
+    
+        end
+
+        protected
+    
+        def check_admin_account
+          if session[Bhf.configuration.session_auth_name.to_s] == true
+            return true
+          end
+          redirect_to(main_app.send(Bhf.configuration.on_login_fail.to_sym),
+            error: t('bhf.helpers.user.login.error')) and return false
+        end
+    
+        def setup_current_account
+          if session[Bhf.configuration.session_account_id]
+            @current_account =
+            Bhf.configuration.account_model.classify.constantize.send(
+              Bhf.configuration.account_model_find_method.to_sym,
+              session[Bhf.configuration.session_account_id.to_s]
+            )
+            # => User.find(current_account.id)
+          end
+        end
+    
+        def current_account
+          @current_account
+        end
+    
+        def get_account_roles(area = nil)
+          return unless current_account
+    
+          if area
+            if current_account.respond_to?(:bhf_area_roles)
+              return current_account.bhf_area_roles(area).collect(&:identifier)
+            end
+          end
+    
+          if current_account.respond_to?(:bhf_roles)
+            current_account.bhf_roles.collect(&:identifier)
+          end
+        end
+    
+        def load_settings
+          yaml_parser = Bhf::Settings::YAMLParser.new(get_account_roles(
+            params[:bhf_area]), params[:bhf_area])
+          @settings =
+          Bhf::Settings::Base.new(yaml_parser.settings_hash, current_account)
+        end
+    
+        def set_title
+          @app_title = Rails.application.class.to_s.split('::').first
+    
+          @title = if params[:bhf_area]
+            t("bhf.areas.page_title.#{params[:bhf_area]}", 
+              area: params[:bhf_area],
+              title: @app_title,
+              default: t('bhf.areas.page_title', 
+                title: @app_title,
+                area: t("bhf.areas.links.#{params[:bhf_area]}",
+                default: params[:bhf_area])
+              )
+            )
+          else
+            t('bhf.page_title', title: @app_title)
+          end.html_safe
+        end
+    
+        def set_areas
+          @areas = []
+          if current_account and current_account.respond_to?(:bhf_areas)
+            current_account.bhf_areas.each do |area|
+              selected = params[:bhf_area] == area.identifier
+              @areas << OpenStruct.new(
+                name: area.to_bhf_s,
+                selected: selected,
+                path: main_app.bhf_path(area.identifier)
+              )
+              @root_link = area.link if selected
+            end
+          end
+        end
+    
+        def set_message(type, model = nil)
+          key = model && ActiveModel::Naming.singular(model)
+          I18n.t("bhf.activerecord.notices.models.#{key}.#{type}",
+            model: model.model_name.human,
+            default: I18n.t("activerecord.notices.messages.#{type}"))
+        end
+    
+        def init_time
+          @start_time = Time.zone.now
+        end
+    
+        def find_platform(platform_name)
+          Bhf::Platform::Base.new(@settings.find_platform_settings(platform_name))
+        end
+    
+        def redirect_back_or_default(default, msg)
+          redirect_to(params[:return_to] || default, flash: msg)
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bhf
 version: !ruby/object:Gem::Version
-  version: 0.10.10
+  version: 0.10.11
 platform: ruby
 authors:
 - Anton Pawlik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-18 00:00:00.000000000 Z
+date: 2015-10-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -162,6 +162,7 @@ extra_rdoc_files:
 files:
 - Gemfile
 - Gemfile.lock
+- Getting_Started.md
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -287,6 +288,7 @@ files:
 - lib/bhf/action_view/form_builder.rb
 - lib/bhf/action_view/form_options.rb
 - lib/bhf/active_record/base.rb
+- lib/bhf/controller/extension.rb
 - lib/bhf/mongoid/document.rb
 - lib/bhf/platform/attribute/abstract.rb
 - lib/bhf/platform/attribute/column.rb