effective_regions 1.8.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 976c64c5a328d5cf16c0e03283e0bce98f3de124826cee670cc68e400ff04dae
-  data.tar.gz: 64bd24889c6f136b80e5bc12126e4aa2282f09066af63f91ddc02366abf3b249
+  metadata.gz: a7aa0433b2e695dd195090cb20d46d4baedecce240bdf62d36cb5e3a071266bf
+  data.tar.gz: 0f9ec81c8a9b84d55cc2a4acd76c076b442c012946d2943b60082ed067cb8295
 SHA512:
-  metadata.gz: 7d28f939878da56fef56b4c66c8570f563b04067ca38ffee7b8bf0ed50470df5377eee5ae70854f3132f2bfe6592fb0585f0f3b48f3e0c4eb23acf64a1c6976f
-  data.tar.gz: c449ac454e0e2c1076211f93832827a9404d2bd9b4a025be50c0eafeae1b01465206e3c5aac16b50e87a51c54f6c210ede2f572f9890d3b604ab35f62c2bc1a5
+  metadata.gz: a9d15123d4576f57191b4ef573b310b1b0dd86aa890e0621740975fdd5666250a07d419c7f21658f52ab669624ee933a163390ff988c79f85137f62086671a37
+  data.tar.gz: 42e37bab17b09f62870ef01e40df40e751644953ed0e8b0c46dc36f2ca6f8fd1544a0371648ae010236280841ca16b3197ba0c19989576b42c2b461a9232d25b

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2014 Code and Effect Inc.
+Copyright 2021 Code and Effect Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -252,36 +252,14 @@ You can overide the default behaviour by passing an Exit URL as a parameter:
 = link_to 'Edit Post Content', effective_regions.edit_path(post_path(@post), :exit => edit_admin_post_path(@post))
 ```
 
-
 ## Authorization
 
-All authorization checks are handled via the config.authorization_method found in the effective_regions.rb initializer.
-
-It is intended for flow through to CanCan, but that is not required.
-
-The authorization method can be defined as:
-
-```ruby
-EffectiveRegions.setup do |config|
-  config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
-end
-```
+All authorization checks are handled through the
+[effective_resources](https://github.com/code-and-effect/effective_resources/)
+gem and its `config.authorization_method` found in
+the `config/initializers/effective_resources.rb` initializer.
 
-or as a method:
-
-```ruby
-EffectiveRegions.setup do |config|
-  config.authorization_method = :authorize_effective_regions
-end
-```
-
-and then in your application_controller.rb:
-
-```ruby
-def authorize_effective_regions(action, resource)
-  can?(action, resource)
-end
-```
+## Permissions
 
 There are 3 different levels of permissions to be considered:
 
@@ -297,19 +275,6 @@ can :update, Effective::Region
 
 can :update, ActsAsRegionableObject  # This would be your Event, Post, or Page, or whatever.
 
-If the method or proc returns false (user is not authorized) an `Effective::AccessDenied` exception will be raised
-
-You can rescue from this exception by adding the following to your application_controller.rb
-
-```ruby
-rescue_from Effective::AccessDenied do |exception|
-  respond_to do |format|
-    format.html { render 'static_pages/access_denied', :status => 403 }
-    format.any { render :text => 'Access Denied', :status => 403 }
-  end
-end
-```
-
 ## Snippets
 
 Snippets are intelligent pieces of content that can be dropped into an effective_region through the full-screen editor's 'Insert Snippet' dropdown.
@@ -633,13 +598,6 @@ Code and Effect is the product arm of [AgileStyle](http://www.agilestyle.com/),
 
 The test suite for this gem is unfortunately not yet complete.
 
-Run tests by:
-
-```ruby
-rake spec
-```
-
-
 ## Contributing
 
 1. Fork it
@@ -648,4 +606,3 @@ rake spec
 4. Push to the branch (`git push origin my-new-feature`)
 5. Bonus points for test coverage
 6. Create new Pull Request
-

data/app/assets/config/effective_regions_manifest.js

@@ -0,0 +1,3 @@
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link_directory ../images/effective/templates

data/app/assets/javascripts/effective/snippets/drop_cap.js.coffee

@@ -0,0 +1,25 @@
+CKEDITOR.dialog.add 'drop_cap', (editor) ->  # Must match the class name of the snippet
+  title: 'A drop cap',
+  minWidth: 200,
+  minHeight: 100,
+  contents: [
+    {
+      id: 'drop_cap_id',    # Just an html id, doesn't really matter what is here
+      elements: [
+        {
+          id: 'letter'
+          type: 'text',
+          label: 'Letter (required)',
+          setup: (widget) -> this.setValue(widget.data.letter)
+          commit: (widget) -> widget.setData('letter', this.getValue())
+        },
+        {
+          id: 'html_class'
+          type: 'text',
+          label: 'Additional html classes (optional)',
+          setup: (widget) -> this.setValue(widget.data.html_class)
+          commit: (widget) -> widget.setData('html_class', this.getValue())
+        }
+      ]
+    }
+  ]

data/app/assets/stylesheets/drop_cap.scss

@@ -0,0 +1,7 @@
+.dropcap {
+  float: left;
+  position: relative;
+  font-size: larger;
+  font-weight: bold;
+  margin-right: 0.5rem;
+}

data/app/controllers/effective/regions_controller.rb

@@ -3,24 +3,20 @@ module Effective
     respond_to :html, :json
     layout false
 
-    if respond_to?(:before_action)
-      skip_before_action :verify_authenticity_token, only: :update
-      before_action :authenticate_user! if defined?(Devise)
-    else
-      skip_before_filter :verify_authenticity_token, only: :update
-      before_filter :authenticate_user! if defined?(Devise)
-    end
+    skip_before_action :verify_authenticity_token, only: :update
+    before_action(:authenticate_user!) if defined?(Devise)
 
-    skip_log_page_views quiet: true, only: [:snippet] if defined?(EffectiveLogging)
+    skip_log_page_views(quiet: true, only: [:snippet]) if defined?(EffectiveLogging)
 
     def edit
-      EffectiveRegions.authorize!(self, :edit, Effective::Region.new)
+      EffectiveResources.authorize!(self, :edit, Effective::Region.new)
 
       cookies['effective_regions_editting'] = {:value => params[:exit].presence || request.referrer, :path => '/'}
 
       # TODO: turn this into a cookie or something better.
       uri = URI.parse(Rack::Utils.unescape(request.url.sub('/edit', '')))
       uri.query = [uri.query, "edit=true"].compact.join('&')
+
       redirect_to uri.to_s
     end
 
@@ -37,15 +33,15 @@ module Effective
           regionable, title = find_regionable(key)
 
           if regionable
-            EffectiveRegions.authorized?(self, :update, regionable) # can I update the regionable object?
+            EffectiveResources.authorized?(self, :update, regionable) # can I update the regionable object?
 
             region = regionable.regions.find { |region| region.title == title }
-            region ||= regionable.regions.build(:title => title)
+            region ||= regionable.regions.build(title: title)
 
             to_save = regionable
           else
-            region = Effective::Region.global.where(:title => title).first_or_initialize
-            EffectiveRegions.authorized?(self, :update, region) # can I update the global region?
+            region = Effective::Region.global.where(title: title).first_or_initialize
+            EffectiveResources.authorized?(self, :update, region) # can I update the global region?
 
             to_save = region
           end
@@ -68,15 +64,15 @@ module Effective
 
         response[:refresh] = true if refresh_page
 
-        render :json => response.to_json(), :status => 200
+        render(json: response.to_json(), status: 200)
         return
       end
 
-      render :text => 'error', :status => :unprocessable_entity
+      render(text: 'error', status: :unprocessable_entity)
     end
 
     def snippet # This is a GET.  CKEDITOR passes us data, we need to render the non-editable content
-      EffectiveRegions.authorize!(self, :edit, Effective::Region.new)
+      EffectiveResources.authorize!(self, :edit, Effective::Region.new)
 
       klass = "Effective::Snippets::#{region_params[:name].try(:classify)}".safe_constantize
 
@@ -153,4 +149,3 @@ module Effective
 
   end
 end
-

data/app/helpers/effective_regions_controller_helper.rb

@@ -2,7 +2,7 @@ module EffectiveRegionsControllerHelper
   def effectively_editing?
     @effectively_editing ||= (
       request.fullpath.include?('edit=true') &&
-      (EffectiveRegions.authorized?(controller, :edit, Effective::Region.new()) rescue false)
+      EffectiveResources.authorized?(controller, :edit, Effective::Region.new)
     )
   end
   alias_method :effectively_editting?, :effectively_editing?

data/app/helpers/effective_regions_helper.rb

@@ -38,8 +38,6 @@ module EffectiveRegionsHelper
     end
   end
 
-  private
-
   def ckeditor_region(args, options = {}, &block)
     obj = args.first
     title = args.last.to_s.parameterize
@@ -63,7 +61,7 @@ module EffectiveRegionsHelper
       region = obj.regions.find { |region| region.title == title }
 
       if effectively_editing?
-        can_edit = (EffectiveRegions.authorized?(controller, :update, obj) rescue false)
+        can_edit = EffectiveResources.authorized?(controller, :update, obj)
         opts[:id] = [model_name_from_record_or_class(obj).param_key(), obj.id, title].join('_')
       end
     else # This is a global region
@@ -71,7 +69,7 @@ module EffectiveRegionsHelper
       region = regions.find { |region| region.title == title } || Effective::Region.new(:title => title)
 
       if effectively_editing?
-        can_edit = (EffectiveRegions.authorized?(controller, :update, region) rescue false)
+        can_edit = EffectiveResources.authorized?(controller, :update, region)
         opts[:id] = title.to_s.parameterize
       end
     end
@@ -112,6 +110,4 @@ module EffectiveRegionsHelper
     end.html_safe
   end
 
-
-
 end

data/app/models/concerns/acts_as_regionable.rb

@@ -1,7 +1,7 @@
 module ActsAsRegionable
   extend ActiveSupport::Concern
 
-  module ActiveRecord
+  module Base
     def acts_as_regionable(*options)
       @acts_as_regionable_opts = options || []
       include ::ActsAsRegionable
@@ -9,7 +9,7 @@ module ActsAsRegionable
   end
 
   included do
-    has_many :regions, :as => :regionable, :class_name => 'Effective::Region', :dependent => :delete_all, :autosave => true
+    has_many :regions, as: :regionable, class_name: 'Effective::Region', dependent: :delete_all, autosave: true
   end
 
   module ClassMethods
@@ -36,4 +36,3 @@ module ActsAsRegionable
   end
 
 end
-

data/app/models/effective/ck_asset.rb

@@ -11,15 +11,12 @@ module Effective
     # The instance ones will have just one file
     has_one_attached :file
 
-    # Attributes
-    # global     :boolean
+    effective_resource do
+      global :boolean
+    end
 
     def self.global
       CkAsset.where(global: true).first || CkAsset.create!(global: true)
     end
   end
 end
-
-
-
-

data/app/models/effective/region.rb

@@ -2,21 +2,22 @@ module Effective
   class Region < ActiveRecord::Base
     self.table_name = EffectiveRegions.regions_table_name.to_s
 
-    belongs_to :regionable, :polymorphic => true
+    belongs_to :regionable, polymorphic: true, optional: true
 
-    # structure do
-    #   title             :string
-    #   content           :text
-    #   snippets          :text
-    #   timestamps
-    # end
+    effective_resource do
+      title     :string
+      content   :text
+      snippets  :text
+
+      timestamps
+    end
 
     serialize :snippets, HashWithIndifferentAccess
 
     scope :global, -> { where("#{EffectiveRegions.regions_table_name}.regionable_type IS NULL").where("#{EffectiveRegions.regions_table_name}.regionable_id IS NULL") }
     scope :with_snippets, -> { where("#{EffectiveRegions.regions_table_name}.snippets ILIKE ?", '%snippet_%') }
 
-    validates_presence_of :title
+    validates :title, presence: true
 
     def snippets
       self[:snippets] || HashWithIndifferentAccess.new()
@@ -41,7 +42,3 @@ module Effective
 
   end
 end
-
-
-
-

data/app/models/effective/snippets/drop_cap.rb

@@ -0,0 +1,11 @@
+module Effective
+  module Snippets
+    class DropCap < Snippet
+
+      def snippet_attributes
+        super + [:letter, :html_class]
+      end
+
+    end
+  end
+end

data/app/views/effective/snippets/_drop_cap.html.haml

@@ -0,0 +1,2 @@
+.dropcap{class: drop_cap.html_class.presence}
+  %span= drop_cap.letter

data/config/effective_regions.rb

@@ -2,29 +2,6 @@ EffectiveRegions.setup do |config|
   config.regions_table_name = :regions
   config.ck_assets_table_name = :ck_assets
 
-  # Authorization Method
-  #
-  # This method is called by all controller actions with the appropriate action and resource
-  # If the method returns false, an Effective::AccessDenied Error will be raised (see README.md for complete info)
-  #
-  # Use via Proc (and with CanCan):
-  # config.authorization_method = Proc.new { |controller, action, resource| can?(action, resource) }
-  #
-  # Use via custom method:
-  # config.authorization_method = :my_authorization_method
-  #
-  # And then in your application_controller.rb:
-  #
-  # def my_authorization_method(action, resource)
-  #   current_user.is?(:admin)
-  # end
-  #
-  # Or disable the check completely:
-  # config.authorization_method = false
-  config.authorization_method = Proc.new { |controller, action, resource| authorize!(action, resource) } # CanCanCan
-
-
-
   # Before Region Save Method
   #
   # This method is called when a User clicks the 'Save' button in the full screen editor.

data/lib/effective_regions.rb

@@ -1,34 +1,15 @@
+require 'effective_resources'
 require 'effective_ckeditor'
 require 'effective_regions/engine'
 require 'effective_regions/version'
 
 module EffectiveRegions
-  mattr_accessor :regions_table_name
-  mattr_accessor :ck_assets_table_name
 
-  mattr_accessor :authorization_method
-  mattr_accessor :before_save_method
-
-  def self.setup
-    yield self
+  def self.config_keys
+    [:regions_table_name, :ck_assets_table_name, :before_save_method]
   end
 
-  def self.authorized?(controller, action, resource)
-    @_exceptions ||= [Effective::AccessDenied, (CanCan::AccessDenied if defined?(CanCan)), (Pundit::NotAuthorizedError if defined?(Pundit))].compact
-
-    return !!authorization_method unless authorization_method.respond_to?(:call)
-    controller = controller.controller if controller.respond_to?(:controller)
-
-    begin
-      !!(controller || self).instance_exec((controller || self), action, resource, &authorization_method)
-    rescue *@_exceptions
-      false
-    end
-  end
-
-  def self.authorize!(controller, action, resource)
-    raise Effective::AccessDenied.new('Access Denied', action, resource) unless authorized?(controller, action, resource)
-  end
+  include EffectiveGem
 
   # Returns a Snippet.new() for every class in the /app/effective/snippets/* directory
   def self.snippets

data/lib/effective_regions/engine.rb

@@ -6,7 +6,9 @@ module EffectiveRegions
 
     # Include Helpers to base application
     initializer 'effective_regions.action_controller' do |app|
-      ActiveSupport.on_load :action_controller do
+      ActiveSupport.on_load :action_controller_base do
+        helper EffectiveRegionsHelper
+
         ActionController::Base.send(:include, ::EffectiveRegionsControllerHelper)
       end
     end
@@ -14,7 +16,7 @@ module EffectiveRegions
     # Include acts_as_addressable concern and allow any ActiveRecord object to call it
     initializer 'effective_regions.active_record' do |app|
       ActiveSupport.on_load :active_record do
-        ActiveRecord::Base.extend(ActsAsRegionable::ActiveRecord)
+        ActiveRecord::Base.extend(ActsAsRegionable::Base)
       end
     end
 
@@ -24,7 +26,7 @@ module EffectiveRegions
     end
 
     initializer "effective_regions.append_precompiled_assets" do |app|
-      Rails.application.config.assets.precompile += ['ck_assets.js', 'ck_assets.css']
+      app.config.assets.precompile += ['effective_regions_manifest.js', 'ck_assets.js', 'ck_assets.css', 'drop_cap.css']
     end
 
   end

data/lib/effective_regions/version.rb

@@ -1,3 +1,3 @@
 module EffectiveRegions
-  VERSION = '1.8.3'.freeze
+  VERSION = '1.10.0'.freeze
 end

data/lib/generators/effective_regions/install_generator.rb

@@ -21,6 +21,7 @@ module EffectiveRegions
 
       def create_migration_file
         @regions_table_name = ':' + EffectiveRegions.regions_table_name.to_s
+        @ck_assets_table_name = : + EffectiveRegions.ck_assets_table_name.to_s
         migration_template ('../' * 3) + 'db/migrate/01_create_effective_regions.rb.erb', 'db/migrate/create_effective_regions.rb'
       end
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: effective_regions
 version: !ruby/object:Gem::Version
-  version: 1.8.3
+  version: 1.10.0
 platform: ruby
 authors:
 - Code and Effect
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2021-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: effective_resources
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: effective_ckeditor
   requirement: !ruby/object:Gem::Requirement
@@ -38,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sassc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create editable content regions within your existing, ordinary ActionView::Base
   views, and update content with an actually-good full-screen WYSIWYG editor.
 email:
@@ -49,21 +77,24 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- app/assets/config/effective_regions_manifest.js
 - app/assets/images/effective/templates/image_and_title.png
 - app/assets/javascripts/ck_assets.js.coffee
 - app/assets/javascripts/effective/snippets/current_date_time.js.coffee
 - app/assets/javascripts/effective/snippets/current_user_info.js.coffee
+- app/assets/javascripts/effective/snippets/drop_cap.js.coffee
 - app/assets/stylesheets/ck_assets.scss
+- app/assets/stylesheets/drop_cap.scss
 - app/controllers/effective/ck_assets_controller.rb
 - app/controllers/effective/regions_controller.rb
 - app/helpers/effective_regions_controller_helper.rb
 - app/helpers/effective_regions_helper.rb
 - app/models/concerns/acts_as_regionable.rb
-- app/models/effective/access_denied.rb
 - app/models/effective/ck_asset.rb
 - app/models/effective/region.rb
 - app/models/effective/snippets/current_date_time.rb
 - app/models/effective/snippets/current_user_info.rb
+- app/models/effective/snippets/drop_cap.rb
 - app/models/effective/snippets/snippet.rb
 - app/models/effective/templates/image_and_title.rb
 - app/models/effective/templates/template.rb
@@ -73,6 +104,7 @@ files:
 - app/views/effective/ck_assets/index.html.haml
 - app/views/effective/snippets/_current_date_time.html.haml
 - app/views/effective/snippets/_current_user_info.html.haml
+- app/views/effective/snippets/_drop_cap.html.haml
 - app/views/effective/templates/_image_and_title.html.haml
 - app/views/effective/templates/_three_column.html.haml
 - app/views/effective/templates/_two_column.html.haml
@@ -89,7 +121,7 @@ homepage: https://github.com/code-and-effect/effective_regions
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -104,8 +136,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Create editable content regions within your existing, ordinary ActionView::Base
   views, and update content with an actually-good full-screen WYSIWYG editor.

data/app/models/effective/access_denied.rb

@@ -1,17 +0,0 @@
-unless defined?(Effective::AccessDenied)
-  module Effective
-    class AccessDenied < StandardError
-      attr_reader :action, :subject
-
-      def initialize(message = nil, action = nil, subject = nil)
-        @message = message
-        @action = action
-        @subject = subject
-      end
-
-      def to_s
-        @message || I18n.t(:'unauthorized.default', :default => 'Access Denied')
-      end
-    end
-  end
-end