admin_it 1.0.9 → 1.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 45f2f0b918cc7598db68bfa95c9531166582e32f
-  data.tar.gz: 20beca7ce9441e4e9daf07193b683d2cce03fdbf
+  metadata.gz: 2b4af7fc6796fe6d148a1d91d62449d2cca40e44
+  data.tar.gz: dcd1542a809878391c15ed5604e74d26b1d7572d
 SHA512:
-  metadata.gz: f3c96628072ee5f826f3363d3f46c0d35913af0f04d63f33cdcb38162c106c533535a32cf3705bfe2dd862086cfcd9ee03c4cc7cb704adf4e115c16e7f1af931
-  data.tar.gz: bab6e0655d1a46847110bea8721ff19ad182e8f5cf516633de1b3edf83a635be1c6ad700c8cb4360f45f384492e5ed51cc8307b2dbd78aa181636262699cd78d
+  metadata.gz: 70d197f764d7b3126e564d7aeaf53cc47ef999f06d00a79db152defaad223725accbc64b7000cc07e92d55e964e2c856e48237c0176df300214081fec304cb62
+  data.tar.gz: b8886811264b9aaef4cbed1c6404eba4a93de24361785322cc86ed8ae7d65a9665136ff3d7cbc4359cf3b50ab872eed31dee8032c4f277d329582d239891240d

data/README.md

@@ -38,6 +38,15 @@ bundle install
 
 # Changes
 
+`1.0.10`
+
+* added: sorting indicator in table column header
+* added: sections
+
+`1.0.9`
+
+* added: filter button in table column header
+
 `1.0.8`
 
 * dsl code fully refactored

data/README_RU.md

@@ -23,19 +23,98 @@ bundle install
 
 Конфигурация производится в файле `config/initializers/admin_it.rb`. На данный момент доступны следующие переменные:
 
+`config.root`: папка, содержащая определения ресурсов и другие настройки. По умолчанию: `app/admin_it`.
+
+`config.controller`: класс контроллера, от которого наследуются все контроллеры, используемые библиотекой `admin_it`. По умолчанию для Rails: `ActionController::Base`.
+
+Пример файла конфигурации:
+
+```ruby
+require 'admin_it'
+
+AdminIt.config do |config|
+  config.root = 'admin_it'
+end
+```
 
 # Использование
 
+Библиотека оперирует такими понятиями, как:
+
+* **Ресурс (resource)** - набор данных, который можно просматривать или изменять. Как правило, ресурс соответствует таблице базы данных. Для каждого ресурса библиотека создаёт отдельный класс контроллера.
+* **Контекст (context)** - представление данных, или форма отображения данных. Контекст может быть для отдельной записи (`единичный контекст`) или для набора данных (`множественный контекст`). На данный момент библиотека предоставляет следующие контексты:
+    - единичные:
+        + `show` - отображение или удаление записи
+        + `edit` - форма для редактирования записи
+        + `new` - форма для создания записи
+    - множественные:
+        + `table` - таблица данных
+        + `tiles` - набор плиток
+        + `list` - список (пока не работает)
+* **Поле (field)** - представляет поле (колонку) данных. Имеет следующие атрибуты:
+    - readable
+    - writable
+    - visible
+* **Фильтр (filter)** - фильтр данных. Пока не закончено.
+
+Для создания интерфейса управления данными, необходимо определить ресурс. Делается это в файле с расширением `.rb` в папке, указанной в конфигурации, например:
+
+```ruby
+AdminIt.resource :location do
+  icon 'globe'
+
+  use_contexts except: :list
+
+  collection do
+    use_fields except: %i(created_at updated_at geo_point geo_data okato
+                          kladr_code lowcase_name short_name area_children
+                          region_children region area)
+    use_filters :type_name_value, :level_value
+  end
+
+  context :tiles do
+    header :name
+  end
+
+  context :table do
+    use_fields :name, :level, :*
+  end
+end
+```
+
+В данном файле создается ресурс для данных класса `Location`. Ресурс использует для отображения иконку "глобус". (Все иконки можно найти [здесь](http://fortawesome.github.io/Font-Awesome/icons/) - имена необходимо указывать без суффикса `fa-`).
+
+Далее указывается, что не нужно использовать (использовать все, кроме) контекст `:list`, посокльку его описание ещё не закончено.
+
+Далее выполняется блок для всех множественных контекстов (поскольку `:list` исключён, то это `:table` и `:tiles`). Т.е. все множественные контексты будут использовать указанные в данном блоке настройки. В нашем случае это сокращенный список полей для удобства отображения и также, сокращённый список фильтров, имеющиё смысл в данном контексте.
+
+Далее идет индивидуальная настройка каждого контекста (не указанные явно контексты принимают все значения по-умолчанию).
+
+Для контекста `:tiles` указывается имя поля, служащее заголоком плитки
+
+Для контекста `:table` указывается порядок следования полей: сначала `:name`, затем `:level`, затем все остальные в порядке по-умолчанию. Символ `:*` заменяется на все имеющиеся для данного контекста поля, не указанные в команде явно.
+
 # Планы
 
 * Поркытие тестами
 * Редактирование/создание записей
 
-## Далёкие планы
+# Изменения
 
-* Поддержка Sinatra
+`1.0.10`
 
-# Изменения
+* добавлен индикатор сортировки в заголовках таблиц
+* добавлены вкладки для единичных контекстов
+
+`1.0.9`
+
+* добавлена кнопка фильтров в заголоки таблиц
+
+`1.0.8`
+
+* полностью переработан код DSL
+* увеличено покрытие тестами
+* добавлена возможность выбора набора фильтров для контекста
 
 `1.0.7`
 

data/app/assets/stylesheets/admin_it/admin_it.css

@@ -23,3 +23,4 @@
 .tab-pane {
   margin-top: 10px;
 }
+

data/app/views/admin_it/context/_show.html.slim

@@ -16,11 +16,32 @@
   - if for_context.confirm == :destroy
     p = t('admin_it.confirm.destroy.header')
 
-dl class="dl-horizontal"
-  - for_context.fields.each do |f|
-    - next if f.type == :relation
-    dt = f.display_name
-    = field f, tag: 'dl'
+- if for_context.sections.size > 0
+  ul class="nav nav-tabs"
+    - for_context.sections.each do |section|
+      li class="#{section.name == for_context.section ? 'active' : ''}"
+        a href="##{section.name}" data-toggle="tab"
+          = section.display_name
+  div class="tab-content"
+    - for_context.sections.each do |section|
+      div class="tab-pane #{section.name == for_context.section ? 'active' : ''}" id==section.name
+        - if section.fields.size > 0
+          dl class="dl-horizontal"
+            - section.fields.each do |f_name|
+              - f = for_context.field(f_name)
+              - next if f.type == :relation
+              dt = f.display_name
+              - value = f.show(for_context.entity)
+              - value = value.nil? ? ' '.html_safe : value.to_s
+              = field value, tag: 'dd'
+- else
+  dl class="dl-horizontal"
+    - for_context.fields.each do |f|
+      - next if f.type == :relation
+      dt = f.display_name
+      - value = f.show(for_context.entity)
+      - value = value.nil? ? ' '.html_safe : value.to_s
+      = field value, tag: 'dd'
 div class="clearfix"
 
 - if for_context.confirm?

data/app/views/admin_it/context/_table.html.slim

@@ -10,9 +10,13 @@
     = _table.header do |header|
       - for_context.headers.each do |k, h|
         - opts = { :'data-toggle' => 'popup' }
-        - opts[:class] = 'text-info' if for_context.sorting.any? { |s| s.index("#{k}:") == 0 }
+        - active_sorting = for_context.sorting.find { |s| s.index("#{k}:") == 0 }
+        - opts[:class] = 'text-info' unless active_sorting.nil?
         = header.cell opts do
           = h
+          - unless active_sorting.nil?
+            = ' '
+            i class="fa fa-caret-#{active_sorting.split(':').last == 'asc' ? 'down' : 'up'}"
           - filter_class = for_context.all_filters(scope: :value).find do |f|
             - f.field.field_name == k
           - unless filter_class.nil?

data/app/views/layouts/admin_it.html.slim

@@ -25,7 +25,7 @@ html
         div class="container"
           <!-- top-menu -->
 
-      div class="container"
+      div class="container admin-it-#{context.name}"
         = render File.join(%w(admin_it shared toolbar))
         = render File.join(%w(admin_it shared filters))
         = yield

data/app/views/layouts/admin_it_dialog.html.slim

@@ -1,6 +1,6 @@
 div class="modal-header"
   h4.modal-title = yield :title
-div class="modal-body"
+div class="modal-body admin-it-#{context.name}"
   = yield
 div class="modal-footer"
   button type="button" class="btn btn-default" data-dismiss="modal"

data/lib/admin_it/context/collection_context.rb

@@ -12,6 +12,7 @@ module AdminIt
     dsl do
       dsl_block :entities, variable: :entities_getter
       dsl_accessor :default_sorting
+      dsl_boolean :show_in_dialog
     end
 
     def self.before_configure
@@ -25,6 +26,10 @@ module AdminIt
       ]
     end
 
+    def self.show_in_dialog?
+      @show_in_dialog.nil? ? @show_in_dialog = true : @show_in_dialog == true
+    end
+
     def self.collection?
       true
     end
@@ -41,7 +46,7 @@ module AdminIt
     end
 
     attr_accessor :entity
-    class_attr_reader :entities_getter, :path
+    class_attr_reader :entities_getter, :path, :show_in_dialog?
 
     before_load do |store: {}, params: {}|
       self.sorting = store[:sorting] || self.class.default_sorting

data/lib/admin_it/context/single_context.rb

@@ -4,25 +4,39 @@ module AdminIt
     include ExtendIt::Dsl
     include Renderable
 
-    attr_reader :name, :display_name
+    attr_reader :name, :display_name, :fields
 
     dsl do
       dsl_accessor :name, :display_name
       dsl_boolean :visible
+
+      def use_fields(*names, except: nil)
+        names = names.ensure_symbols
+        fields =
+          if names.nil? || names.empty?
+            dsl_get(:fields, default: [])
+          else
+            context = dsl_get(:context, default: nil)
+            names & context.fields.map(&:field_name)
+          end
+        fields -= except.ensure_symbols unless except.nil?
+        dsl_set(:fields, fields.uniq)
+      end
     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)
+    def initialize(name, context, display_name: nil)
       @name = name
       @display_name = display_name || name
-      @fields = fields
+      @context = context
+      @fields = context.fields.map(&:field_name)
+      context.sections.each do |section|
+        next if section.name == name
+        @fields -= section.fields
+      end
     end
   end
 
@@ -53,12 +67,12 @@ module AdminIt
           #general.display_name(I18n.t('admin_it.collection.no_data'))
           general = Section.new(
             :general,
-            *fields.map(&:field_name),
+            self,
             display_name: 'Основные свойства'
           )
           @sections[:general] = general
         end
-        Section.new(name)
+        name == :general ? @sections[:general] : Section.new(name, self)
       end
     end
 

data/lib/admin_it/data/active_record.rb

@@ -3,6 +3,21 @@ module AdminIt
     module Resource
       protected
 
+      TYPE_MAPPING = {
+        primary_key: :integer,
+        string: :string,
+        text: :string,
+        integer: :integer,
+        float: :float,
+        decimal: :float,
+        datetime: :datetime,
+        timestamp: :datetime,
+        time: :time,
+        date: :date,
+        binary: :binary,
+        boolean: :boolean
+      }
+
       def default_display_name
         entity_class
           .model_name
@@ -24,7 +39,7 @@ module AdminIt
           entity_class.columns_hash.each do |name, c|
             next if exclude.include?(name)
             name = name.to_sym
-            opts = { type: c.type }
+            opts = { type: TYPE_MAPPING[c.type] }
             if name == :id
               opts[:visible] = false
               opts[:writable] = false
@@ -50,7 +65,7 @@ module AdminIt
     module CollectionContext
       def entities=(value)
         super(value)
-        @count = value.count
+        @count = @entities.nil? ? 0 : @entities.count
       end
 
       protected
@@ -70,7 +85,9 @@ module AdminIt
           name, order = _sort.split(':')
           sort[name.to_sym] = order.to_sym
         end
-        collection = collection.order(sort) unless sort.empty?
+        unless collection.nil? || sort.empty?
+          collection = collection.order(sort)
+        end
         collection
       end
     end

data/lib/admin_it/field/field.rb

@@ -15,7 +15,8 @@ module AdminIt
     extend DisplayableName
     include ExtendIt::Callbacks
 
-    TYPES = %i(unknown integer float string date relation enum)
+    TYPES = %i(unknown integer float string date datetime time relation enum
+               binary)
 
     define_callbacks :initialize
 
@@ -29,16 +30,16 @@ module AdminIt
       dsl_block :read, :write, :render, :display
 
       def hide
-        @visible = false
+        dsl_set(:visible, false)
       end
 
       def show
-        @visible = true
+        dsl_set(:visible, true)
       end
     end
 
     class << self
-      attr_reader :type, :read, :write, :render, :display
+      attr_reader :read, :write, :render, :display, :type
 
       protected
 
@@ -65,27 +66,29 @@ module AdminIt
 
     inherited_class_reader :field_name, :entity_class
 
-    def self.create(name, _entity_class,
-                    type: :unknown,
-                    readable: true,
-                    writable: true,
-                    visible: true,
-                    sortable: true
-                   )
+    def self.create(name, _entity_class, **opts)
+#                    type: :unknown,
+#                    readable: true,
+#                    writable: true,
+#                    visible: true,
+#                    sortable: true
+#                   )
       base = self
+#      _type, _readable, _writable, _visible, _sortable =
+#        type, readable, writable, visible, sortable
       Class.new(base) do
         @field_name, @entity_class = name, _entity_class
         import_data_module(base)
-        @readable = readable == true
-        @writable = writable == true
-        @visible = visible == true
-        @sortable = sortable == true
-        self.type = type
+        @readable = opts[:readable].nil? ? true : opts[:readable] == true
+        @writable = opts[:writable].nil? ? true : opts[:writable] == true
+        @visible = opts[:visible].nil? ? true : opts[:visible] == true
+        @sortable = opts[:sortable].nil? ? true : opts[:sortable] == true
+        self.type = opts[:type]
       end
     end
 
     def self.type=(value)
-      TYPES.include?(value) ? value : TYPES[0]
+      @type = TYPES.include?(value) ? value : TYPES[0]
     end
 
     def self.placeholder

data/lib/admin_it/helpers/table.rb

@@ -25,11 +25,18 @@ module AdminIt
         resource = parent.parent.resource
         single = resource.singles.select { |c| !(c <= NewContext) }
         buttons = single.map do |_context|
+          if _context <= ShowContext && context.show_in_dialog?
+            '<a class="btn btn-xs btn-info" ' +
+            %Q{data-toggle="modal" data-target="#confirm_modal" } +
+            %Q{href="#{_context.path(entity)}?layout=dialog">} +
+            %Q{<i class="fa fa-#{_context.icon}"></i></a>}
+          else
             cl = _context <= ShowContext ? 'info' : 'default'
             href = _context.path(entity)
             "<a class=\"btn btn-xs btn-#{cl}\" href=\"#{href}\">" \
             "<i class=\"fa fa-#{_context.icon}\"></i></a>"
           end
+        end
         if resource.destroyable?
           if context.confirm_destroy?
             confirm = single.find { |c| c.context_name == :confirm } ||

data/lib/admin_it/version.rb

@@ -1,5 +1,5 @@
 #
 module AdminIt
   # Current gem version
-  VERSION = '1.0.9'
+  VERSION = '1.0.10'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: admin_it
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.10
 platform: ruby
 authors:
 - Alexey Ovchinnikov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-16 00:00:00.000000000 Z
+date: 2014-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails