kms_models 0.6.0

data/app/models/kms/entry.rb

@@ -0,0 +1,64 @@
+module Kms
+  class Entry < ActiveRecord::Base
+    include Liquor::Dropable
+    extend ::FriendlyId
+    include CompileTemplates
+
+    friendly_id :slug_candidates, use: :slugged
+    belongs_to :model
+    after_save :store_files, if: :cache_names_present?
+
+    validates :slug, uniqueness: { scope: :model_id }
+
+    attr_reader :cache_names
+
+    def slug_candidates
+      [values[model.label_field]]
+    end
+
+    def permalink
+      templatable_page = Kms::Page.where(templatable_type: model.name).first
+      return nil unless templatable_page
+      Pathname.new(templatable_page.parent.fullpath).join(slug.to_s).to_s
+    end
+
+    def values
+      read_attribute(:values) || {}
+    end
+
+    def values=(new_values)
+      files_params = new_values.select { |_, v| v.is_a?(ActionDispatch::Http::UploadedFile) || v.is_a?(File) }
+      @cache_names ||= {}
+      files_params.each do |k, v|
+        uploader = EntryFileUploader.new(OpenStruct.new(model: self, field_name: k))
+        uploader.cache!(v)
+        @cache_names[k] = uploader.cache_name
+        files_params[k] = v.original_filename
+      end
+      super values.merge new_values.merge(files_params)
+    end
+
+    def method_missing(name, *args, &block)
+      model.fields.where(liquor_name: name.to_s).exists? ? values[name.to_s] : super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      model.fields.where(liquor_name: method_name.to_s).exists? || super
+    end
+
+    protected
+
+    def cache_names_present?
+      cache_names.present?
+    end
+
+    def store_files
+      values.each do |k, v|
+        next unless cache_names.keys.include? k
+        uploader = EntryFileUploader.new(OpenStruct.new(model: self, field_name: k))
+        uploader.retrieve_from_cache!(cache_names[k])
+        uploader.store!
+      end
+    end
+  end
+end

data/app/models/kms/field.rb

@@ -0,0 +1,12 @@
+module Kms
+  class Field < ActiveRecord::Base
+    belongs_to :model
+    scope :file_fields, -> { where(type: Kms::FileField.name) }
+    scope :checkbox_fields, -> { where(type: Kms::CheckboxField.name) }
+
+    def get_value(entry)
+      # OVERRIDE in subclasses if needed
+      entry.values[liquor_name]
+    end
+  end
+end

data/app/models/kms/file_field.rb

@@ -0,0 +1,10 @@
+module Kms
+    class FileField < Field
+      def get_value(entry)
+        value = entry.values[liquor_name]
+        uploader = EntryFileUploader.new(OpenStruct.new(model: entry, field_name: liquor_name))
+        uploader.retrieve_from_store! value
+        uploader.url
+      end
+    end
+end

data/app/models/kms/has_many_field.rb

@@ -0,0 +1,9 @@
+module Kms
+  class HasManyField < Field
+    def get_value(entry)
+      entry_ids = entry.values[liquor_name]
+      association_records = Kms::Entry.where(id: entry_ids)
+      Liquor::DropDelegation.wrap_scope(association_records)
+    end
+  end
+end

data/app/models/kms/model.rb

@@ -0,0 +1,22 @@
+module Kms
+  class Model < ActiveRecord::Base
+    has_many :fields, class_name: 'Kms::Field', dependent: :destroy
+    has_many :entries, class_name: 'Kms::Entry', dependent: :destroy
+    accepts_nested_attributes_for :fields, allow_destroy: true
+
+    def name
+      id.to_s
+    end
+
+    # Hacking hack
+    def model_name
+      value = kms_model_name
+      value.instance_eval do
+        def human(options={})
+          self
+        end
+      end
+      value
+    end
+  end
+end

data/app/models/kms/models_wrapper.rb

@@ -0,0 +1,14 @@
+module Kms
+  class ModelsWrapper
+    include Liquor::Dropable
+
+    def method_missing(name, *args, &block)
+      model = Kms::Model.find_by(collection_name: name.to_s)
+      model ? model.entries.order('position') : super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      Kms::Model.where(collection_name: method_name.to_s).exists? || super
+    end
+  end
+end

data/app/models/kms/page_decorator.rb

@@ -0,0 +1,18 @@
+Kms::Page.class_eval do
+  # fetch item by slug
+  def fetch_item!(slug)
+    return nil unless templatable?
+    templatable_type.constantize.find_by_slug!(slug)
+  rescue NameError
+    Kms::Entry.find_by_slug!(slug)
+  end
+
+  # fetch items for templatable page
+  def fetch_items
+    templatable_type.constantize.all
+  rescue NameError
+    # in templatable_type we store id of Kms::Model object in this case
+    model = Kms::Model.find(templatable_type.to_i)
+    model.entries
+  end
+end

data/app/models/kms/string_field.rb

@@ -0,0 +1,4 @@
+module Kms
+  class StringField < Field
+  end
+end

data/app/models/kms/text_field.rb

@@ -0,0 +1,4 @@
+module Kms
+  class TextField < Field
+  end
+end

data/app/serializers/kms/entry_serializer.rb

@@ -0,0 +1,23 @@
+module Kms
+  class EntrySerializer < ActiveModel::Serializer
+    attributes :id, :values, :position, :slug
+
+    has_one :model, serializer: Kms::SimpleModelSerializer
+
+    # OPTIMIZE
+    def values
+      values_with_urls = object.values.dup
+      # prepare file fields
+      object.model.fields.file_fields.each do |file_field|
+        uploader = EntryFileUploader.new(OpenStruct.new(model: object, field_name: file_field.liquor_name))
+        uploader.retrieve_from_store! values_with_urls[file_field.liquor_name]
+        values_with_urls[file_field.liquor_name] = { url: uploader.url }
+      end
+      # prepare checkbox fields - cause PostgreSQL json stored as strings
+      object.model.fields.checkbox_fields.each do |checkbox_field|
+        values_with_urls[checkbox_field.liquor_name] = values_with_urls[checkbox_field.liquor_name] == 'true'
+      end
+      values_with_urls
+    end
+  end
+end

data/app/serializers/kms/simple_model_serializer.rb

@@ -0,0 +1,5 @@
+module Kms
+  class SimpleModelSerializer < ActiveModel::Serializer
+    attributes :id, :label_field
+  end
+end

data/app/uploaders/entry_file_uploader.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+
+class EntryFileUploader < CarrierWave::Uploader::Base
+
+  # Include RMagick or MiniMagick support:
+  # include CarrierWave::RMagick
+  # include CarrierWave::MiniMagick
+
+  # Choose what kind of storage to use for this uploader:
+  storage :file
+  # storage :fog
+
+  # Override the directory where uploaded files will be stored.
+  # This is a sensible default for uploaders that are meant to be mounted:
+  def store_dir
+    "uploads/#{model.model.class.to_s.underscore}/#{model.model.id}/#{model.field_name}"
+  end
+
+  # Provide a default URL as a default if there hasn't been a file uploaded:
+  # def default_url
+  #   # For Rails 3.1+ asset pipeline compatibility:
+  #   # ActionController::Base.helpers.asset_path("fallback/" + [version_name, "default.png"].compact.join('_'))
+  #
+  #   "/images/fallback/" + [version_name, "default.png"].compact.join('_')
+  # end
+
+  # Process files as they are uploaded:
+  # process :scale => [200, 300]
+  #
+  # def scale(width, height)
+  #   # do something
+  # end
+
+  # Create different versions of your uploaded files:
+  # version :thumb do
+  #   process :resize_to_fit => [50, 50]
+  # end
+
+  # Add a white list of extensions which are allowed to be uploaded.
+  # For images you might use something like this:
+  # def extension_white_list
+  #   %w(jpg jpeg gif png)
+  # end
+
+  # Override the filename of the uploaded files:
+  # Avoid using model.id or version_name here, see uploader/store.rb for details.
+  # def filename
+  #   "something.jpg" if original_filename
+  # end
+
+end

data/app/views/layouts/kms_models/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>KmsModels</title>
+  <%= stylesheet_link_tag    "kms_models/application", media: "all" %>
+  <%= javascript_include_tag "kms_models/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/initializers/ability.rb

@@ -0,0 +1,7 @@
+if Kms::Model.table_exists?
+  Kms::Model.all.each do |model|
+    Kms::AbilityService.register do
+      can :manage, model
+    end
+  end
+end

data/config/initializers/externals.rb

@@ -0,0 +1 @@
+Kms::ExternalsRegistry.register(:models) {|_,_| Kms::ModelsWrapper.new.to_drop }

data/config/initializers/help.rb

@@ -0,0 +1 @@
+Kms::HelpService.register_templates Kms::Models::Engine, 'help/models_variables.html'

data/config/initializers/resources.rb

@@ -0,0 +1,6 @@
+Kms::ResourceService.register(:models, Kms::Model, "fa-tasks")
+if Kms::Model.table_exists?
+  Kms::Model.all.each do |model|
+    Kms::ResourceService.register(:models, model, "fa-tasks")
+  end
+end

data/config/locales/en.yml

@@ -0,0 +1,52 @@
+en:
+  models: "Models"
+  add_model: "Add Model"
+  new_model: "New Model"
+  edit_model: "Edit Model"
+  update_model: "Update Model"
+  add_entry: "Add Entry"
+  new_entry: "New Entry"
+  edit_entry: "Edit Entry"
+  update_entry: "Update Entry"
+  no_fields_yet: "No fields yet. Add first field using form below."
+  select_field_type: "Select field type"
+  select_model: "Select Model"
+  collection_name_field_hint: "You can access model collection like this: models.your_collection_name (ex., models.services)"
+  has_many_field_placeholder: "Select related objects..."
+  belongs_to_field_placeholder: "Select related object..."
+  field_types:
+    string: "String"
+    text: "Text"
+    checkbox: "Checkbox"
+    file: "File"
+    has_many: "Has many"
+    belongs_to: "Belongs to"
+  liquor_help:
+    variables:
+      models:
+        main_description: 'Variable "models" gives access to models collections of entries. You can access collection using model collection name - "Collection name (for Liquor)" field. For example, if you created some Model with "services" collection name, then you could iterate its collection using "for" tag like this:'
+  activerecord:
+    models:
+      kms/model:
+        one: "Model"
+        few: "Models"
+        many: "Models"
+        other: "Models"
+      kms/entry:
+        one: "Entry"
+        few: "Entries"
+        many: "Entries"
+        other: "Entries"
+    attributes:
+      kms/model:
+        kms_model_name: "Name"
+        collection_name: "Collection name (for Liquor)"
+        fields: "Fields"
+        label_field: "Label field (used for URL/slug generating)"
+      kms/field:
+        name: "Name"
+        liquor_name: "Name for Liquor"
+        type: "Type"
+        required: "Required"
+      kms/entry:
+        slug: "Slug"

data/config/locales/ru.yml

@@ -0,0 +1,52 @@
+ru:
+  models: "Модели"
+  add_model: "Добавить модель"
+  new_model: "Новая Модель"
+  edit_model: "Редактирование модели"
+  update_model: "Обновить модель"
+  add_entry: "Добавить элемент"
+  new_entry: "Новый Элемент"
+  edit_entry: "Редактирование Элемента"
+  update_entry: "Обновить элемент"
+  no_fields_yet: "Пока нет ни одного свойства. Добавьте первое свойство с помощью формы ниже."
+  select_field_type: "Выберите тип свойства"
+  select_model: "Выберите модель"
+  collection_name_field_hint: "К коллекции можно будет обратиться так: models.your_collection_name (напр., models.services)"
+  has_many_field_placeholder: "Выберите связанные объекты..."
+  belongs_to_field_placeholder: "Выберите связанный объект..."
+  field_types:
+    string: "Строка"
+    text: "Текст"
+    checkbox: "Чекбокс"
+    file: "Файл"
+    has_many: "Имеет много"
+    belongs_to: "Связано с"
+  liquor_help:
+    variables:
+      models:
+        main_description: 'Переменная models предоставляет доступ к коллекциям моделей, определённых пользователем на вкладке "Модели". Доступ осуществляется через название коллекции модели - поле "Название коллекции (для Liquor)" при создании модели. Например, если создана модель с названием коллекции services, то можно использовать for для итерации по элементам коллекции следующим образом:'
+  activerecord:
+    models:
+      kms/model:
+        one: "Модель"
+        few: "Модели"
+        many: "Моделей"
+        other: "Модели"
+      kms/entry:
+        one: "Элемент"
+        few: "Элемента"
+        many: "Элементов"
+        other: "Элементы"
+    attributes:
+      kms/model:
+        kms_model_name: "Название"
+        collection_name: "Название коллекции (для Liquor)"
+        fields: "Свойства"
+        label_field: "Поле, используемое для генерации ссылок на объекты"
+      kms/field:
+        name: "Название"
+        liquor_name: "Название для Liquor"
+        type: "Тип"
+        required: "Обязательное"
+      kms/entry:
+        slug: "Ссылка/URL"

data/config/routes.rb

@@ -0,0 +1,11 @@
+Kms::Models::Engine.routes.draw do
+  constraints(format: "json") do
+    resources :models, format: true do
+      resources :entries, format: true do
+        member do
+          post '' => 'entries#update'
+        end
+      end
+    end
+  end
+end

data/db/migrate/20150409124420_create_kms_models.rb

@@ -0,0 +1,10 @@
+class CreateKmsModels < ActiveRecord::Migration
+  def change
+    create_table :kms_models do |t|
+      t.string :model_name
+      t.string :collection_name
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150409125056_create_kms_fields.rb

@@ -0,0 +1,13 @@
+class CreateKmsFields < ActiveRecord::Migration
+  def change
+    create_table :kms_fields do |t|
+      t.string :name
+      t.string :liquor_name
+      t.string :type
+      t.boolean :required
+      t.belongs_to :model
+
+      t.timestamps null: false
+    end
+  end
+end

data/db/migrate/20150413143711_create_kms_entries.rb

@@ -0,0 +1,10 @@
+class CreateKmsEntries < ActiveRecord::Migration
+  def change
+    create_table :kms_entries do |t|
+      t.belongs_to :model, index: true
+      t.json :values
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20150820080436_add_label_field_to_kms_models.rb

@@ -0,0 +1,5 @@
+class AddLabelFieldToKmsModels < ActiveRecord::Migration
+  def change
+    add_column :kms_models, :label_field, :string
+  end
+end

data/db/migrate/20150820132142_add_slug_to_kms_entries.rb

@@ -0,0 +1,6 @@
+class AddSlugToKmsEntries < ActiveRecord::Migration
+  def change
+    add_column :kms_entries, :slug, :string
+    add_index :kms_entries, :slug, unique: true
+  end
+end

data/db/migrate/20150821201250_fix_models_column_name.rb

@@ -0,0 +1,5 @@
+class FixModelsColumnName < ActiveRecord::Migration
+  def change
+    rename_column :kms_models, :model_name, :kms_model_name
+  end
+end

data/db/migrate/20150901115303_add_class_name_to_kms_fields.rb

@@ -0,0 +1,5 @@
+class AddClassNameToKmsFields < ActiveRecord::Migration
+  def change
+    add_column :kms_fields, :class_name, :string
+  end
+end

data/db/migrate/20150910081440_add_position_to_kms_entries.rb

@@ -0,0 +1,5 @@
+class AddPositionToKmsEntries < ActiveRecord::Migration
+  def change
+    add_column :kms_entries, :position, :integer, default: 0, null: false
+  end
+end

data/lib/drops/kms/entry_drop.rb

@@ -0,0 +1,67 @@
+module Kms
+  class EntryDrop < Liquor::Drop
+
+    attributes :id, :created_at, :permalink, :model_collection_name
+    scopes :order
+
+    # overriding methods cause we work with 'json' column
+    class Scope
+      def find_by(_, fields={})
+        fields, = Liquor::Drop.unwrap_scope_arguments([ fields ])
+
+        json_queries = fields.map {|name, value| "values ->> '#{name}' = ?" }
+        result = @source.where(json_queries.join(" AND "), *fields.values.map(&:to_s)).first
+        Liquor::DropDelegation.wrap_element result if result
+      end
+
+      def find_all_by(_, fields={})
+        fields, = Liquor::Drop.unwrap_scope_arguments([ fields ])
+
+        json_queries = fields.map {|name, value| "values ->> '#{name}' = ?" }
+        result = @source.where(json_queries.join(" AND "), *fields.values.map(&:to_s))
+        Liquor::DropDelegation.wrap_scope(result)
+      end
+
+      def order(*args)
+        args = Liquor::Drop.unwrap_scope_arguments(args)
+        parsed_args = args.map do |arg|
+          order_clause = arg.split(' ')
+          if order_clause[0].in? ["id", "created_at", "updated_at", "position"]
+            order_clause.join(' ')
+          else
+            ["values ->> '#{order_clause[0]}'", order_clause[1].to_s].join(' ')
+          end
+        end
+        # we use reorder because by default we order by position
+        Liquor::DropDelegation.wrap_scope @source.reorder(*parsed_args)
+      end
+    end
+
+    def initialize(source)
+      self.class.instance_eval do
+        source.model.fields.pluck(:liquor_name).each do |field_name|
+          export field_name.to_sym
+        end
+      end
+      super(source)
+    end
+
+    def method_missing(name, *args, &block)
+      field = source.model.fields.find_by(liquor_name: name.to_s)
+      field ? field.get_value(source) : super
+    end
+
+    def respond_to_missing?(method_name, include_private = false)
+      source.model.fields.where(liquor_name: method_name.to_s).exists? || super
+    end
+
+    def created_at
+      source.created_at.to_s
+    end
+
+    def model_collection_name
+      source.model.collection_name
+    end
+
+  end
+end

data/lib/drops/kms/models_wrapper_drop.rb

@@ -0,0 +1,12 @@
+module Kms
+  class ModelsWrapperDrop < Liquor::Drop
+    def self.register_model(collection_name)
+      has_many collection_name.to_sym
+    end
+
+    Kms::Model.pluck(:collection_name).each do |collection_name|
+      register_model collection_name
+    end
+
+  end
+end

data/lib/generators/kms_models/install/install_generator.rb

@@ -0,0 +1,17 @@
+module KmsModels
+  class InstallGenerator < Rails::Generators::Base
+
+    source_root File.expand_path('../../../../../', __FILE__)
+
+    def insert_engine_routes
+      route %(
+  mount Kms::Models::Engine => '/kms'
+      )
+    end
+
+    def insert_javascript
+      append_file "app/assets/javascripts/application.js", "//= require kms_models/application\n"
+    end
+
+  end
+end

data/lib/kms/models/engine.rb

@@ -0,0 +1,15 @@
+require "friendly_id"
+module Kms
+  module Models
+    class Engine < ::Rails::Engine
+      engine_name 'kms_models'
+      isolate_namespace Kms::Models
+      config.autoload_paths += Dir["#{config.root}/lib/**/"]
+      config.to_prepare do
+        Dir.glob(File.join(File.dirname(__FILE__), "../../../app/**/*_decorator*.rb")) do |c|
+          require_dependency(c)
+        end
+      end
+    end
+  end
+end

data/lib/kms/models/version.rb

@@ -0,0 +1,5 @@
+module Kms
+  module Models
+    VERSION = '0.6.0'
+  end
+end

data/lib/kms_models.rb

@@ -0,0 +1,6 @@
+require "kms/models/engine"
+
+module Kms
+  module Models
+  end
+end

data/lib/tasks/kms_models_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :kms_models do
+#   # Task goes here
+# end

data/test/dummy/README.rdoc

@@ -0,0 +1,28 @@
+== README
+
+This README would normally document whatever steps are necessary to get the
+application up and running.
+
+Things you may want to cover:
+
+* Ruby version
+
+* System dependencies
+
+* Configuration
+
+* Database creation
+
+* Database initialization
+
+* How to run the test suite
+
+* Services (job queues, cache servers, search engines, etc.)
+
+* Deployment instructions
+
+* ...
+
+
+Please feel free to use a different markup language if you do not plan to run
+<tt>rake doc:app</tt>.

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Rails.application.load_tasks