admin_it 1.0.7 → 1.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c69b40dfe779b858729883eea07b1077f74216b4
-  data.tar.gz: 7ba60b0a798165f512348b509411fffad8f1d17f
+  metadata.gz: f3c78b05180f3886708f8ebb99413ae49d655d1d
+  data.tar.gz: 777702fc5bc52596130f80447c686859460d442f
 SHA512:
-  metadata.gz: 7a55e137e2e089570a4a00faeeee9eeb1cc38657b5055b3153d304e785a1b6109cf1a1281b9e525ab9185d4c04c3906105711678f573bee09d5fe43d2b1a7452
-  data.tar.gz: 7bbfd6ff962a80ac79adeb880730693c072d5b003828f5d6c27d9b2dbd9da95e6154752d63689557de88f908760f2834032052c1a1e0cd587aa07d15597b33d6
+  metadata.gz: 8d1eca80d0a17486ef98a48c0d74bd5b146c37b04b4ffa98849231077bad3f73f0a2bc5368da5ff58b39427e82811ee8604a01494258084ac228938a37499c13
+  data.tar.gz: 3b51e836dc3cd9742b06e33a479f48e2f4d4a8af7e525eda044361ce838e797b86e82b37fd5982327e3d845efe96793e049d6fea792cd7156acb352720056122

data/.ruby-version

@@ -0,0 +1 @@
+2.1.1

data/README.md

@@ -38,6 +38,12 @@ bundle install
 
 # Changes
 
+`1.0.8`
+
+* dsl code fully refactored
+* test coverage enlarged
+* added: select specific filters for context
+
 `1.0.7`
 
 * destoy entity fixed

data/lib/admin_it/context/collection_context.rb

@@ -1,19 +1,17 @@
 require 'json'
 require 'csv'
-require File.join %w(extend_it symbolize)
-
-using ExtendIt::Symbolize
 
 module AdminIt
   class CollectionContext < Context
     extend FiltersHolder
 
-    @entities_getter = nil
-
     class << self
-      dsl_block :entities
+      attr_reader :entities_getter, :default_sorting
+    end
+
+    dsl do
+      dsl_block :entities, variable: :entities_getter
       dsl_accessor :default_sorting
-      dsl_use_hash :filters
     end
 
     def self.before_configure
@@ -27,21 +25,6 @@ module AdminIt
       ]
     end
 
-    def self.filter(name, filter_class: nil, &block)
-      assert_symbol(:name)
-      if @filters.key?(name)
-        filter = @filters[name] = Class.new(@filters[name]) if block_given?
-      else
-        filter_class = Filter if filter_class.nil? || !filter_class <= Filter
-        filter = @filters[name] = filter_class.create(name, self)
-      end
-      filter.instance_eval(&block) if block_given?
-    end
-
-    def self.entities_getter
-      @entities
-    end
-
     def self.collection?
       true
     end

data/lib/admin_it/context/context.rb

@@ -1,35 +1,32 @@
 require 'uri'
 require File.join %w(extend_it dsl)
-require File.join %w(extend_it array_of)
-require File.join %w(extend_it symbolize)
+require File.join %w(extend_it base)
+require File.join %w(extend_it callbacks)
 
-using ExtendIt::Symbolize
+using ExtendIt::Ensures
 
 module AdminIt
   class Context
-    extend ExtendIt::Class
+    extend ExtendIt::Base
     extend ExtendIt::Dsl
-    include ExtendIt::Callbacks
-    extend DataBehavior
+    extend Iconed
     extend FieldsHolder
+    extend DataBehavior
+    include ExtendIt::Callbacks
 
     class << self
-      extend ExtendIt::Dsl
-
       attr_reader :context_name
       attr_accessor :controller_class
+    end
 
-      dsl_accessor :icon do |value|
-        value.nil? ? default_icon : value.to_s
-      end
-      dsl_use_hash :fields
+    dsl do
       dsl_boolean :confirm_destroy
     end
 
     inherited_class_reader :resource, :entity_class
     define_callbacks :initialize, :load, :save
 
-    def self.create(context_name, _resource, &block)
+    def self.create(context_name, _resource)
       fail ArgumentError, 'Wrong resource' unless _resource.is_a?(Resource)
       base = self
       Class.new(base) do
@@ -45,21 +42,11 @@ module AdminIt
         ]
 
         before_configure if respond_to?(:before_configure)
-        instance_eval(&block) if block_given?
-        after_configure if respond_to?(:after_configure)
       end
     end
 
-    def self.field(*names, field_class: nil, &block)
-      names.ensure_symbols.each do |name|
-        if @fields.key?(name)
-          field = @fields[name] = Class.new(@fields[name]) if block_given?
-        else
-          field_class = Field if field_class.nil? || !field_class <= Field
-          field = @fields[name] = field_class.create(name, entity_class)
-        end
-        field.instance_eval(&block) if block_given?
-      end
+    def self.confirm_destroy?
+      @confirm_destroy.nil? ? true : @confirm_destroy == true
     end
 
     def self.collection?
@@ -84,15 +71,7 @@ module AdminIt
       url
     end
 
-    class << self
-      protected
-
-      def default_icon
-        ''
-      end
-    end
-
-    class_attr_reader :collection?, :single?, :entity_class, :resource, :icon,
+    class_attr_reader :collection?, :single?, :entity_class, :resource,
                       :entity_path?, :confirm_destroy?
     attr_reader :top_menu, :toolbar, :parent, :template, :controller
 

data/lib/admin_it/context/show_context.rb

@@ -1,12 +1,11 @@
 module AdminIt
   class ShowContext < SingleContext
+    extend Renderable
     include Identifiable
 
     CONFIRMS = %i(destroy update)
 
     class << self
-      include Renderable
-
       protected
 
       def default_icon
@@ -14,15 +13,17 @@ module AdminIt
       end
     end
 
+    dsl do
+      dsl_block :read
+    end
+
     def self.entity_path?
       true
     end
 
-    def self.read(entity = nil, &block)
-      if entity.nil?
-        @reader = block if block_given?
-      elsif !@reader.nil?
-        @reader.call(entity)
+    def self.read(entity)
+      unless @read.nil?
+        @read.call(entity)
       end
     end
 

data/lib/admin_it/context/single_context.rb

@@ -1,18 +1,29 @@
-require File.join %w(extend_it dsl)
-require File.join %w(extend_it symbolize)
-
-using ExtendIt::Symbolize
-
 module AdminIt
   class Section
-    extend ExtendIt::Dsl
+    extend ExtendIt::Base
+    include ExtendIt::Dsl
     include Renderable
-    dsl_accessor :name, :display_name
-    dsl_boolean :visible
-    # dsl_block :render_context
+
+    attr_reader :name, :display_name
+
+    dsl do
+      dsl_accessor :name, :display_name
+      dsl_boolean :visible
+    end
+
+    def visible?
+      @visible.nil? ? @visible = true : @visible == true
+    end
+
     def fields(*names)
       names.empty? ? @fields ||= [] : @fields = names
     end
+
+    def initialize(name, *fields, display_name: nil)
+      @name = name
+      @display_name = display_name || name
+      @fields = fields
+    end
   end
 
   module Identifiable
@@ -33,37 +44,28 @@ module AdminIt
   end
 
   class SingleContext < Context
-    class << self
+    dsl do
       dsl_block :entity_getter, :entity_saver, :entity_destroyer
+
+      dsl_hash_of_objects :sections, single: :section do |name, **opts|
+        if @sections.empty?
+          # TODO: require this and other files after I18n config in engine.rb
+          #general.display_name(I18n.t('admin_it.collection.no_data'))
+          general = Section.new(
+            :general,
+            *fields.map(&:field_name),
+            display_name: 'Основные свойства'
+          )
+          @sections[:general] = general
+        end
+        Section.new(name)
+      end
     end
 
     def self.sections
       (@sections ||= {}).values
     end
 
-    def self.section(*names, &block)
-      @sections ||= {}
-      names.ensure_symbols.each do |name|
-        if @sections.key?(name)
-          section = @sections[name]
-        else
-          if @sections.empty?
-            general = Section.new
-            general.name(:general)
-            # TODO: require this and other files after I18n config in engine.rb
-            #general.display_name(I18n.t('admin_it.collection.no_data'))
-            general.display_name('Основные свойства')
-            general.fields(*fields.map(&:field_name))
-            @sections[:general] = general
-          end
-          section = Section.new
-          section.name(name)
-          @sections[name] = section
-        end
-        section.instance_eval(&block) if block_given?
-      end
-    end
-
     def self.single?
       true
     end

data/lib/admin_it/context/table_context.rb

@@ -1,16 +1,12 @@
-require File.join %w(extend_it dsl)
-
 module AdminIt
   class TableContext < CollectionContext
-    class << self
-      dsl_accessor :page_size, default: 10 do |value|
-        value.is_a?(Fixnum) && value > 0 ? value : 10
-      end
-
+    dsl do
+      dsl_accessor :page_size, default: 10
       dsl_boolean :actions
-
       dsl_block :row
+    end
 
+    class << self
       protected
 
       def default_icon
@@ -18,12 +14,23 @@ module AdminIt
       end
     end
 
+    def self.actions?
+      @actions.nil? ? true : @actions == true
+    end
+
+    def self.page_size
+      @page_size ||= 10
+    end
+
+    def self.page_size=(value)
+      @page_size = value.is_a?(Fixnum) && value > 0 ? value : 10
+    end
+
     def self.path
-      AdminIt::Engine.routes
-        .url_helpers.send("table_#{resource.plural}_path")
+      AdminIt::Engine.routes.url_helpers.send("table_#{resource.plural}_path")
     end
 
-    class_attr_reader :page_size, :actions?
+    class_attr_reader :page_size, :actions?, :row
 
     after_load do |store: {}, params: {}|
       self.page = params[:page] || store[:page]

data/lib/admin_it/context/tiles_context.rb

@@ -1,24 +1,15 @@
-require File.join %w(extend_it dsl)
-
 module AdminIt
   class TilesContext < CollectionContext
-    class << self
+    dsl do
       dsl_accessor :header do |value|
-        if value.nil?
-          fields.empty? ? nil : fields.first.name
-        else
-          field = fields.find { |f| f.field_name == value }
-          field.nil? ? header(nil) : field.field_name
-        end
+        field = fields.find { |f| f.field_name == value }
+        field.nil? ? header : field.field_name
       end
     end
 
-    def self.path
-      AdminIt::Engine.routes
-        .url_helpers.send("tiles_#{resource.plural}_path")
-    end
-
     class << self
+      attr_reader :header
+
       protected
 
       def default_icon
@@ -26,6 +17,15 @@ module AdminIt
       end
     end
 
+    def self.header
+      fields.empty? ? nil : fields.first.name
+    end
+
+    def self.path
+      AdminIt::Engine.routes
+        .url_helpers.send("tiles_#{resource.plural}_path")
+    end
+
     class_attr_reader :header
   end
 end

data/lib/admin_it/data/active_record.rb

@@ -1,5 +1,3 @@
-require File.join %w(extend_it class)
-
 module AdminIt
   module ActiveRecordData
     module Resource

data/lib/admin_it/field/field.rb

@@ -1,4 +1,4 @@
-require File.join %w(extend_it class)
+require File.join %w(extend_it base)
 require File.join %w(extend_it dsl)
 require File.join %w(extend_it callbacks)
 
@@ -9,42 +9,60 @@ module AdminIt
   # @author [alexiss]
   #
   class Field
-    extend ExtendIt::Class
+    extend ExtendIt::Base
     extend DataBehavior
+    extend ExtendIt::Dsl
+    extend DisplayableName
     include ExtendIt::Callbacks
 
     TYPES = %i(unknown integer float string date relation enum)
 
-    define_callbacks :initialize#, :configure
+    define_callbacks :initialize
 
-    class << self
-      extend ExtendIt::Dsl
+    dsl do
+      dsl_accessor :type, default: TYPES[0]
 
-      # attr_reader :field_name, :entity_class
+      dsl_accessor :placeholder
 
-      dsl_accessor :display_name do |value = nil|
-        value.nil? ? default_display_name : value.to_s
-      end
+      dsl_boolean :readable, :writable, :visible, :sortable
 
-      dsl_accessor :type, default: TYPES[0] do |value|
-        TYPES.include?(value) ? value : TYPES[0]
-      end
+      dsl_block :read, :write, :render, :display
 
-      dsl_accessor :placeholder do |value = nil|
-        value.nil? ? display_name : value
+      def hide
+        @visible = false
       end
 
-      dsl_boolean :readable, :writable, :visible, :sortable
+      def show
+        @visible = true
+      end
+    end
 
-      dsl_block :read, :write, :render, :display
+    class << self
+      attr_reader :type, :read, :write, :render, :display
 
       protected
 
       def default_display_name
-        name.to_s
+        field_name
       end
     end
 
+    def self.readable?
+      @readable.nil? ? @readable = true : @readable == true
+    end
+
+    def self.writable?
+      @writable.nil? ? @writable = true : @writable == true
+    end
+
+    def self.visible?
+      @visible.nil? ? @visible = true : @visible == true
+    end
+
+    def self.sortable?
+      @sortable.nil? ? @sortable = true : @sortable == true
+    end
+
     inherited_class_reader :field_name, :entity_class
 
     def self.create(name, _entity_class,
@@ -56,18 +74,24 @@ module AdminIt
                    )
       base = self
       Class.new(base) do
-        #run_callbacks :configure do
         @field_name, @entity_class = name, _entity_class
         import_data_module(base)
-        self.readable = readable
-        self.writable = writable
-        self.visible = visible
-        self.sortable = sortable
+        @readable = readable == true
+        @writable = writable == true
+        @visible = visible == true
+        @sortable = sortable == true
         self.type = type
-        #end
       end
     end
 
+    def self.type=(value)
+      TYPES.include?(value) ? value : TYPES[0]
+    end
+
+    def self.placeholder
+      @placeholder ||= display_name
+    end
+
     def self.hide
       @visible = false
     end
@@ -171,4 +195,52 @@ module AdminIt
             "Attempt to write to field #{name} with unimplemented writer"
     end
   end
+
+  module FieldsHolder
+    extend ExtendIt::DslModule
+
+    dsl do
+      dsl_hash_of_objects :fields, single: :field do |name, **opts|
+        field_class = opts[:class] || opts[:field_class] || Field
+        unless field_class.is_a?(Class) && field_class <= Field
+          fail(
+            ArgumentError,
+            'field class should be AdminIt::Field descendant'
+          )
+        end
+        field_class.create(name, entity_class)
+      end
+
+      def hide_fields(*names)
+        hash = dsl_get(:fields, {})
+        names.ensure_symbols.each do |name|
+          hash[name].hide if hash.key?(name)
+        end
+      end
+
+      def show_fields(*names)
+        hash = dsl_get(:fields, {})
+        names.ensure_symbols.each do |name|
+          hash[name].show if hash.key?(name)
+        end
+      end
+    end
+
+    def fields(scope: :visible)
+      case scope
+      when nil, :all then @fields.values
+      when :visible then @fields.values.select { |f| f.visible? }
+      when :hidden then @fields.values.select { |f| !f.visible? }
+      when :readable then @fields.values.select { |f| f.readable? }
+      when :writable then @fields.values.select { |f| f.writable? }
+      when :sortable then @fields.values.select { |f| f.sortable? }
+      when Field::TYPES then @fields.values.select { |f| f.type == scope }
+      else @fields.values
+      end
+    end
+
+    def field(name)
+      @fields[name.ensure_symbol]
+    end
+  end
 end

data/lib/admin_it/filters/field_filter.rb

@@ -1,5 +1,9 @@
 module AdminIt
   class FieldFilter < Filter
+    dsl do
+      dsl_accessor :field
+    end
+
     class << self
       attr_reader :field
 

data/lib/admin_it/filters/filter.rb

@@ -1,19 +1,16 @@
 require 'date'
 require 'json'
-require File.join %w(extend_it class)
+require File.join %w(extend_it base)
 require File.join %w(extend_it dsl)
 require File.join %w(extend_it callbacks)
-require File.join %w(extend_it asserts)
-require File.join %w(extend_it symbolize)
-
-using ExtendIt::Symbolize
 
 module AdminIt
   class Filter
-    extend ExtendIt::Class
+    extend ExtendIt::Base
+    extend ExtendIt::Dsl
     extend DataBehavior
+    extend DisplayableName
     include ExtendIt::Callbacks
-    extend ExtendIt::Asserts
 
     REGEXP = /
       (?<=\A|[,;|])\s*
@@ -41,18 +38,16 @@ module AdminIt
     define_callbacks :initialize, :save, :load
 
     class << self
-      extend ExtendIt::Dsl
-
       attr_reader :filter_name, :resource
 
-      dsl_accessor :display_name do |value = nil|
-        value.nil? ? default_display_name : value.to_s
-      end
-
       protected
 
       def create_class(name, _resource)
-        assert_symbol(:name, binding: binding)
+        name = name.ensure_symbol || fail(
+          ArgumentError,
+          '`name` argument for `Filter::create_class` should be a Symbol' \
+          ' or a String'
+        )
         base = self
         Class.new(base) do
           @filter_name, @resource = name, _resource
@@ -211,4 +206,32 @@ module AdminIt
       end
     end
   end
+
+  module FiltersHolder
+    extend ExtendIt::DslModule
+
+    dsl do
+      dsl_hash_of_objects :filters, single: :filter do |name, **opts|
+        filter_class = opts[:class] || opts[:filter_class] || Filter
+        unless filter_class.is_a?(Class) && filter_class <= Filter
+          fail(
+            ArgumentError,
+            'filter class should be AdminIt::Filter descendant'
+          )
+        end
+        filter_class.create(name, entity_class)
+      end
+    end
+
+    def filters(scope: :all)
+      case scope
+      when nil, :all then @filters.values
+      else @filters.values
+      end
+    end
+
+    def filter(name)
+      @filters[name.ensure_symbol]
+    end
+  end
 end

data/lib/admin_it/helpers/table.rb

@@ -34,28 +34,24 @@ module AdminIt
           if context.confirm_destroy?
             confirm = single.find { |c| c.context_name == :confirm } ||
                       single.first { |c| c <= ShowContext }
-            buttons << if confirm.nil?
-              @template.link_to(
+            unless confirm.nil?
+              buttons <<
+                '<a class="btn btn-xs btn-danger" ' +
+                %Q{data-toggle="modal" data-target="#confirm_modal" } +
+                %Q{href="#{confirm.path(entity)}} +
+                '?layout=dialog&confirm=destroy">' +
+                '<i class="fa fa-trash-o"></i></a>'
+            end
+          else
+            show = single.first { |c| c <= ShowContext }
+            unless show.nil?
+              buttons << @template.link_to(
                 html_safe('<i class="fa fa-trash-o"></i>'),
                 show.path(entity),
                 method: :delete,
-                confirm: I18n.t('admin_it.confirm.destroy.text'),
                 class: 'btn btn-xs btn-danger'
               )
-            else
-              '<a class="btn btn-xs btn-danger" ' +
-              %Q{data-toggle="modal" data-target="#confirm_modal" } +
-              %Q{href="#{confirm.path(entity)}} +
-              '?layout=dialog&confirm=destroy">' +
-              '<i class="fa fa-trash-o"></i></a>'
             end
-          else
-            buttons << @template.link_to(
-              html_safe('<i class="fa fa-trash-o"></i>'),
-              show.path(entity),
-              method: :delete,
-              class: 'btn btn-xs btn-danger'
-            )
           end
         end
 
@@ -77,7 +73,7 @@ module AdminIt
       child :actions, ActionsCell
 
       before_capture do
-        block = parent.context.class.row
+        block = parent.context.row
         unless block.nil?
           instance_exec(parent.context.entity, &block)
         end