ez-settings 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ab92996758b0720c782a270a27937d4e62d2f84a
+  data.tar.gz: ccad41c32652e4f590a428b7e64268e0605b1ee3
+SHA512:
+  metadata.gz: 1a07335a8448a2baf82d96f22c67855aa02c24cb8b2e8a2f9f14fa3a6304cf2b53448aa717670238253efef4aaa2515975787d6dba3cd31db8cfabab5940673d
+  data.tar.gz: a61b3c69ff16ebe41297861b902add48fe025da4e95e748610c0e89570244293a6aeb238a7fca05b25df37ff151f3f8eb50e8fbcbdae85c682df42049816e0c2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Volodya Sveredyuk
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,241 @@
+# Ez::Settings
+**Ez Settings** (read as "easy settings") - one of the [ez-engines](https://github.com/ez-engines) collection that helps easily add settings interface to your [Rails](http://rubyonrails.org/) application.
+
+- Flexible tool with simple DSL
+- Convetion over configuration principles.
+- Depends on [ez-core](https://github.com/ez-engines/ez-core)
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ez-settings'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install ez-settings
+```
+
+## Setup
+
+### Initializer
+
+Create initializer: `config/initializers/ez_settings.rb` (rails generator would be added in 0.2 version)
+
+If you are boring to read all this stuff maybe this video motivates you:
+
+[YouTube demonstrates how easy we integrated ez-settings for our pivorak-web-app only by ±50 lines of code](https://www.youtube.com/watch?v=TiX0QDHEaKA&feature=youtu.be)
+
+```ruby
+# By default engine try to inherit from ApplicationController, but you could change this:
+# Ez::Settings.config.base_controller = 'Admin::BaseController'
+#
+# Then you should define settings interfaces (you can create as much as you need)
+# Ierachy is pretty simple: Interface -> Group -> Key
+#
+# Interface DSL allows you to do this very declaratively
+#
+#
+app = Ez::Settings::Interface.define :app do         # :app - interface name
+  group :general do                                  # :general will be name of the group
+    key :app_title, default: -> { 'Main app title' } # :app_title will be as settings key name for store value in :general group for :app interface
+  end
+
+  # And so on...
+  group :admin do
+    key :app_title, default: -> { 'Admin app title' }
+  end
+
+  # If you want to see all power of the engine, add this showcase:
+  group :showcase do
+    key :string,                        default: -> { 'simple string' }
+    key :bool,         type: :boolean,  default: -> { true }
+    key :integer,      type: :integer,  default: -> { 777 }
+    key :select,       type: :select,   default: -> { 'foo' }, collection: %w(foo bar baz)
+    key :not_validate, required: false, presence: false
+    key :not_for_ui,   required: false, ui:       false
+  end
+  # Keys could have:
+  # :type (string by default), now ez-settings supports only: string, boolean, integer and select
+  # :default value (as callable objects)
+  # :required - be or not (all keys are required by default)
+  # :ui visible or not (all keys are UI visible by default)
+end
+
+# After defining settings interface groups/keys you need to configure it:
+app.configure do |config|
+  # Backend adapter to store all settings (in current version only file system)
+  config.backend = Ez::Settings::Backend::FileSystem.new(Rails.root.join('config', 'settings.yml'))
+
+  # Default path for redirect in controller
+  config.default_path = '/admin/settings'
+
+  # Pass your custom css classes through css_map config
+  # Defaults would be merged with yours:
+  # config.custom_css_map  = {
+  #   nav_label:                           'ez-settings-nav-label',
+  #   nav_menu:                            'ez-settings-nav-menu',
+  #   nav_menu_item:                       'ez-settings-nav-menu-item',
+  #   overview_page_wrapper:               'ez-settings-overview',
+  #   overview_page_section:               'ez-settings-overview-section',
+  #   overview_page_section_header:        'ez-settings-overview-section-header',
+  #   overview_page_section_content:       'ez-settings-overview-section-content',
+  #   overview_page_section_content_key:   'ez-settings-overview-section-content-key',
+  #   overview_page_section_content_value: 'ez-settings-overview-section-content-value',
+  #   group_page_wrapper:                  'ez-settings-group-wrapper',
+  #   group_page_inner_wrapper:            'ez-settings-group-inner-wrapper',
+  #   group_page_header:                   'ez-settings-group-header',
+  #   group_page_form_wrapper:             'ez-settings-group-form-wrapper',
+  #   group_page_form_inner:               'ez-settings-group-form-inner',
+  #   group_page_form_field_row:           'ez-settings-group-form-field-row',
+  #   group_page_form_string_wrapper:      'ez-settings-group-form-string-wrapper',
+  #   group_page_form_boolean_wrapper:     'ez-settings-group-form-boolean-wrapper',
+  #   group_page_form_select_wrapper:      'ez-settings-group-form-select-wrapper',
+  #   group_page_actions_wrapper:          'ez-settings-group-actions-wrapper',
+  #   group_page_actions_wrapper:          'ez-settings-group-actions-wrapper',
+  #   group_page_actions_save_button:      'ez-settings-group-actions-save-btn',
+  #   group_page_actions_cancel_link:      'ez-settings-group-actions-cancel-link'
+  # }
+  #
+  # Highly recommend inspecting settings page DOM.
+  # You can find there a lot of interesting id/class stuff
+  #
+  # You even can define dynamic map for allows to decide which CSS class could be added
+  # `if` must contain callable object that receives controller as a first argument and dynamic element as second one:
+  #
+  # In this example, you easily could add 'active' CSS class if route end with some fragment:
+  # config.dynamic_css_map = {
+  #   nav_menu_item: {
+  #     css_class: 'active',
+  #     if: ->(controller, path_fragment) { controller.request.path.end_with?(path_fragment.to_s) }
+  #   }
+  # }
+end
+
+# EzSettings uses Ez::Registry from ez-core lib for storing all knowledges in one place.
+# This place is registry records for :settings_interfaces registry
+#
+# Register `app` variable as settings interface
+Ez::Registry.in(:settings_interfaces, by: PivorakWebApp) do |registry|
+  registry.add app
+end
+```
+### Routes
+`config/routes.rb`
+```ruby
+Rails.application.routes.draw do
+  # your routes code before
+
+  # We recommend to hide settings into admin area
+  authenticate :user, ->(u) { u.admin? } do
+    namespace :admin do
+      # :app just interface name as you registred it in Ez::Registry
+      ez_settings_for :app
+    end
+  end
+
+  # more your routes after
+end
+```
+
+This routes setup allows you to have routes like:
+
+`rake routes | grep settings`
+```
+ admin_ez_settings          /admin/settings  Ez::Settings::Engine {:interface=>:app}
+
+  root GET  /                 ez/settings/settings#index
+       GET  /:group(.:format) ez/settings/settings#show
+       PUT  /:group(.:format) ez/settings/settings#update
+```
+
+In case of example above you could route:
+```
+GET      /admin/settings/         - overview page for all :app interface settings
+GET/PUT: /admin/settings/general  - general group settings
+GET/PUT: /admin/settings/admin    - admin group settings
+GET/PUT: /admin/settings/showcase - showcase group settings
+```
+
+### Settings accessors
+In your app you could access to settings values through:
+```ruby
+Ez::Settings[:all, :general, :app_title]
+Ez::Settings[:all, :admin, :app_title]
+Ez::Settings[:all, :showcase, :select]
+```
+Just use template: `Ez::Settings['interface', 'group', 'key']`
+
+In the case of missing interface/group/key you will receive one of exceptions:
+```
+NotRegistredInterfaceError
+NotRegistredGroupError
+NotRegistredKeyError
+```
+Be careful ;)
+
+### I18n
+
+By default, all interfaces/groups/keys name would be humanized, but in fact, it tries to get translations from YAML first.
+
+If you need, create locale file with this structure:
+
+`config/locales/ez-settings.en.yml`
+```yaml
+  en:
+    ez_settings:
+      label: Ez Settings
+      interfaces:
+        app:
+          label: App Settings
+          actions:
+            save:
+              label: Save Settings
+            cancel:
+              label: Cancel Settings
+          groups:
+            general:
+              label: General
+            admin:
+              label: Admin
+            showcase:
+              label: Showcase
+              keys:
+                string:
+                  label: String
+                bool:
+                  label: Bool
+                integer:
+                  label: Integer
+                select:
+                  label: Select
+                not_validate:
+                  label: Not Validate
+                not_for_ui:
+                  label: Not For UI
+```
+
+## TODO
+This features will be implemented in upcoming 0.2 and 0.3 releases:
+- `rails g ez:settings:install` it creates `config/ez_settings.rb` and `config/locales/ez-settings.en.yml`
+- Scoped settings (`:scope_id`, `:scope_type`)
+- groups as defined methods for interface
+- controller before actions as configured callbacks
+- JSON API endpoints
+- Allow to config endpoints
+- Interface description (and show at UI)
+- Groups description (and show at UI)
+- Database storage as backend
+- Redis storage as backend
+
+## Contributing
+Fork => Fix => MR warmly welcomed!
+
+## License
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,28 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Ez::Settings'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/config/ez_settings_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/ez/settings .js
+//= link_directory ../stylesheets/ez/settings .css

data/app/assets/javascripts/ez/settings/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file. JavaScript code in this file should be added after the last require_* statement.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/ez/settings/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/cells/ez/settings/base_cell.rb

@@ -0,0 +1,95 @@
+module Ez::Settings
+  class BaseCell < Cell::ViewModel
+    include RequestDispatcher
+
+    self.view_paths = ["#{Ez::Settings::Engine.root}/app/cells"]
+
+    delegate :t, to: I18n
+    delegate :params, :request, to: :controller
+    delegate :dynamic_css_map,  to: :'interface.config'
+
+    SCOPE      = 'ez_settings'
+    LABEL      = 'label'
+    INTERFACES = 'interfaces'
+    GROUPS     = 'groups'
+    KEYS       = 'keys'
+    ACTIONS    = 'actions'
+    SAVE       = 'save'
+    CANCEL     = 'cancel'
+
+    def self.form
+      include ActionView::Helpers::FormHelper
+      include SimpleForm::ActionViewExtensions::FormHelper
+      include ActionView::RecordIdentifier
+      include ActionView::Helpers::FormOptionsHelper
+    end
+
+    def self.option(name, default: nil)
+      define_method name do
+        options[name]
+      end
+    end
+
+    def css_for(item, dynamic: nil)
+      return "ez-settings-defined-#{item}" unless css_map[item]
+      return css_map[item] unless dynamic
+
+      if dynamic_css_map.dig(item, :if)&.call(controller, dynamic)
+        dynamic_css_map.dig(item, :css_class) + ' ' + css_map[item]
+      else
+        css_map[item]
+      end
+    end
+
+    def css_map
+      {
+        nav_label:                           'ez-settings-nav-label',
+        nav_menu:                            'ez-settings-nav-menu',
+        nav_menu_item:                       'ez-settings-nav-menu-item',
+        overview_page_wrapper:               'ez-settings-overview',
+        overview_page_section:               'ez-settings-overview-section',
+        overview_page_section_header:        'ez-settings-overview-section-header',
+        overview_page_section_content:       'ez-settings-overview-section-content',
+        overview_page_section_content_key:   'ez-settings-overview-section-content-key',
+        overview_page_section_content_value: 'ez-settings-overview-section-content-value',
+        group_page_wrapper:                  'ez-settings-group-wrapper',
+        group_page_inner_wrapper:            'ez-settings-group-inner-wrapper',
+        group_page_header:                   'ez-settings-group-header',
+        group_page_form_wrapper:             'ez-settings-group-form-wrapper',
+        group_page_form_inner:               'ez-settings-group-form-inner',
+        group_page_form_field_row:           'ez-settings-group-form-field-row',
+        group_page_form_string_wrapper:      'ez-settings-group-form-string-wrapper',
+        group_page_form_boolean_wrapper:     'ez-settings-group-form-boolean-wrapper',
+        group_page_form_select_wrapper:      'ez-settings-group-form-select-wrapper',
+        group_page_actions_wrapper:          'ez-settings-group-actions-wrapper',
+        group_page_actions_wrapper:          'ez-settings-group-actions-wrapper',
+        group_page_actions_save_button:      'ez-settings-group-actions-save-btn',
+        group_page_actions_cancel_link:      'ez-settings-group-actions-cancel-link',
+      }.merge(interface.config.custom_css_map)
+    end
+
+    def controller
+      context[:controller]
+    end
+
+    def group_link(group, options = {})
+      link_to i18n_group_label(group),
+        group_path(group),
+        class: css_for(:nav_menu_item, dynamic: "settings/#{group.name}")
+    end
+
+    def group_path(group)
+      "#{interface.config.default_path}/#{group.name}"
+    end
+
+    def i18n_group_label(group)
+      t(LABEL, scope:   [SCOPE, INTERFACES, group.interface, GROUPS, group.name],
+               default: group.name.to_s.humanize)
+    end
+
+    def i18n_key_label(key)
+      t(LABEL, scope:   [SCOPE, INTERFACES, key.interface, GROUPS, key.group, KEYS, key.name],
+               default: key.name.to_s.humanize)
+    end
+  end
+end

data/app/cells/ez/settings/group/show.slim

@@ -0,0 +1,17 @@
+#ez-settings
+  = cell 'ez/settings/nav'
+
+  div class="#{css_for :group_page_wrapper} ez-settings-group-#{group.name}"
+    div class=(css_for :group_page_inner_wrapper)
+      div class=(css_for :group_page_header)
+        = i18n_group_label(group)
+
+      div class=(css_for :group_page_form_wrapper)
+        = simple_form_for store, as: :settings, url: form_url, method: :put do |f|
+          div class=(css_for :group_page_form_inner)
+            - ui_keys.each do |key|
+              = cell 'ez/settings/key', key, form: f
+
+            div class=(css_for :group_page_actions_wrapper)
+              = save_button(f)
+              = cancel_link

data/app/cells/ez/settings/group_cell.rb

@@ -0,0 +1,26 @@
+module Ez::Settings
+  class GroupCell < BaseCell
+    form
+
+    property :ui_keys
+    option :store
+
+    def form_url
+      "#{interface.config.default_path}/#{model.name}"
+    end
+
+    def save_button(form)
+      form.button :submit,
+        t(LABEL, scope:   [SCOPE, INTERFACES, model.interface, ACTIONS, SAVE],
+                 default: 'Save'),
+        class: css_for(:group_page_actions_save_button)
+    end
+
+    def cancel_link
+      link_to t(LABEL, scope:   [SCOPE, INTERFACES, model.interface, ACTIONS,CANCEL],
+                       default: 'Cancel'),
+        interface.config.default_path,
+        class: css_for(:group_page_actions_cancel_link)
+    end
+  end
+end

data/app/cells/ez/settings/index/show.slim

@@ -0,0 +1,18 @@
+#ez-settings
+  = cell 'ez/settings/nav'
+
+  div class="#{css_for :overview_page_wrapper}"
+    - interface.groups.each do |group|
+
+      div class="#{css_for :overview_page_section}"
+        div class="#{css_for :overview_page_section_header}"
+          = group_link(group)
+
+        - group.ui_keys.each do |key|
+          div class="#{css_for :overview_page_section_content}"
+
+            div class="#{css_for :overview_page_section_content_key}"
+              = i18n_key_label(key)
+
+            div class="#{css_for :overview_page_section_content_value}"
+              = group.store(interface.config.backend).send(key.name)

data/app/cells/ez/settings/index_cell.rb

@@ -0,0 +1,4 @@
+module Ez::Settings
+  class IndexCell < BaseCell
+  end
+end

data/app/cells/ez/settings/key/show.slim

@@ -0,0 +1,4 @@
+div class=(css_for :group_page_form_field_row)
+  div id=(css_for "#{interface.name}-#{model.group}-#{model.name}-wrapper".to_sym)
+   div class=(css_for "group_page_form_#{model.type}_wrapper".to_sym)
+    = form.input model.name, html_options

data/app/cells/ez/settings/key_cell.rb

@@ -0,0 +1,21 @@
+module Ez::Settings
+  class KeyCell < BaseCell
+    form
+
+    option :form
+
+    private
+
+    def html_options
+      {
+        label:           i18n_key_label(model),
+        as:              model.type,
+        collection:      model.collection,
+        include_blank:   model.default.present?,
+        required:        model.required?,
+        checked_value:   TRUE.to_s,
+        unchecked_value: FALSE.to_s
+      }.merge(model.options)
+    end
+  end
+end

data/app/cells/ez/settings/nav/show.slim

@@ -0,0 +1,9 @@
+.ez-settings-nav
+  div class=(css_for :nav_label)
+    = nav_label
+
+  div class=(css_for :nav_menu)
+    = settings_link
+
+    - interface.groups.each do |group|
+      = group_link(group)

data/app/cells/ez/settings/nav_cell.rb

@@ -0,0 +1,13 @@
+module Ez::Settings
+  class NavCell < BaseCell
+    def nav_label
+      t(LABEL, scope: SCOPE, default: 'Settings')
+    end
+
+    def settings_link
+      link_to nav_label,
+        interface.config.default_path,
+        class: css_for(:nav_menu_item, dynamic: 'settings/')
+    end
+  end
+end

data/app/controllers/ez/settings/application_controller.rb

@@ -0,0 +1,11 @@
+module Ez
+  module Settings
+    class ApplicationController < Ez::Settings.config.base_controller.constantize
+      protect_from_forgery with: :exception
+
+      def view(cell_name, *args)
+        render html: cell("ez/settings/#{cell_name}", *args), layout: true
+      end
+    end
+  end
+end

data/app/controllers/ez/settings/settings_controller.rb

@@ -0,0 +1,35 @@
+module Ez
+  module Settings
+    class SettingsController < Ez::Settings::ApplicationController
+      include Ez::Settings::RequestDispatcher
+
+      def index
+        view :index
+      end
+
+      def show
+        render_group(group, group.store(backend))
+      end
+
+      def update
+        store = group.store(backend).update(params[:settings])
+
+        if store.valid?
+          redirect_to interface.config.default_path
+        else
+          render_group(group, store)
+        end
+      end
+
+      private
+
+      def render_group(group, store)
+        view :group, group, store: store
+      end
+
+      def backend
+        interface.config.backend
+      end
+    end
+  end
+end

data/app/helpers/ez/settings/application_helper.rb

@@ -0,0 +1,6 @@
+module Ez
+  module Settings
+    module ApplicationHelper
+    end
+  end
+end

data/app/models/ez/settings/application_record.rb

@@ -0,0 +1,7 @@
+module Ez
+  module Settings
+    class ApplicationRecord < ActiveRecord::Base
+      self.abstract_class = true
+    end
+  end
+end

data/config/routes.rb

@@ -0,0 +1,8 @@
+Ez::Settings::Engine.routes.draw do
+  scope module: 'ez/settings' do
+    root to: 'settings#index'
+
+    get ':group', to: 'settings#show'
+    put ':group', to: 'settings#update'
+  end
+end

data/lib/ez/settings.rb

@@ -0,0 +1,10 @@
+require 'ez/settings/engine'
+
+require 'ez/registry'
+
+require 'ez/settings/interface'
+require 'ez/settings/accessors'
+
+module Ez::Settings
+  extend Accessors
+end

data/lib/ez/settings/accessors.rb

@@ -0,0 +1,31 @@
+module Ez::Settings
+  NotRegistredInterfaceError = Class.new(StandardError)
+  NotRegistredGroupError     = Class.new(StandardError)
+  NotRegistredKeyError       = Class.new(StandardError)
+
+  module Accessors
+    def [](interface_name, group_name, key_name)
+      interface = Ez::Registry.data(:settings_interfaces).find do |interface|
+        interface.name == interface_name.to_sym
+      end
+
+      unless interface
+        raise NotRegistredInterfaceError, "Interface #{interface_name} is not registred!"
+      end
+
+      group = interface.groups.find { |g| g.name == group_name.to_sym }
+
+      unless group
+        raise NotRegistredGroupError, "Group #{group_name} is not registred for #{interface_name} interface"
+      end
+
+      store = Ez::Settings::Store.new(group, interface.config.backend)
+
+      begin
+        store.send(key_name.to_sym)
+      rescue NoMethodError
+        raise NotRegistredKeyError, "Key #{key_name} is not registred for #{interface_name} interface, #{group_name} group"
+      end
+    end
+  end
+end

data/lib/ez/settings/backend/file_system.rb

@@ -0,0 +1,24 @@
+require 'yaml'
+require 'active_support/hash_with_indifferent_access'
+
+module Ez::Settings
+  module Backend
+    class FileSystem
+      attr_reader :file
+
+      def initialize(file)
+        @file = file
+      end
+
+      def read
+        return {} unless File.exist?(file)
+
+        YAML.load_file(file).deep_symbolize_keys
+      end
+
+      def write(data)
+        File.write(file, read.merge(data).deep_stringify_keys.to_yaml)
+      end
+    end
+  end
+end

data/lib/ez/settings/config.rb

@@ -0,0 +1,9 @@
+require 'ez/configurator'
+
+module Ez::Settings
+  include Ez::Configurator
+
+  configure do |config|
+    config.base_controller = 'ApplicationController'
+  end
+end

data/lib/ez/settings/engine.rb

@@ -0,0 +1,13 @@
+require 'cells-rails'
+require 'cells-slim'
+require 'simple_form'
+
+require 'ez/settings/routes'
+require 'ez/settings/request_dispatcher'
+
+module Ez
+  module Settings
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/ez/settings/interface.rb

@@ -0,0 +1,65 @@
+require_relative 'interface/group'
+require_relative 'interface/key'
+require_relative 'store'
+
+require 'ez/configurator'
+require 'ez/settings/backend/file_system'
+
+module Ez::Settings
+  class Interface
+    include Ez::Configurator
+
+    configure do |config|
+      config.base_controller = 'ApplicationController'
+      config.default_path    = '/settings'
+      config.backend         = Backend::FileSystem.new('settings.yml')
+      config.custom_css_map  = {}
+      config.dynamic_css_map = {}
+    end
+
+    def self.define(name, &block)
+      interface = new(name)
+      interface.instance_eval(&block)
+      interface
+    end
+
+    delegate :config, :configure, to: :class
+
+    attr_reader :name, :groups, :store
+
+    def initialize(name)
+      @name = name
+      @keys, @groups = [], []
+    end
+
+    def define(&block)
+      self.instance_eval(&block)
+    end
+
+    def group(name, &block)
+      find_or_initialize_group(name, &block)
+    end
+
+    def keys
+      groups.map(&:keys).flatten
+    end
+
+    private
+
+    def find_or_initialize_group(name, &block)
+      existing_group = groups.find { |g| g.name == name }
+
+      if existing_group
+        existing_group.instance_eval(&block)
+      else
+        add_group(Group.new(name, self.name, &block))
+      end
+    end
+
+    def add_group(group)
+      @groups << group
+
+      group
+    end
+  end
+end

data/lib/ez/settings/interface/group.rb

@@ -0,0 +1,44 @@
+require_relative 'key'
+require_relative '../store'
+
+module Ez::Settings
+  class Interface
+    class Group
+      OverwriteKeyError = Class.new(StandardError)
+
+      attr_reader :name, :options, :keys, :store, :interface
+
+      def initialize(name, interface, options = {}, &block)
+        @name      = name
+        @interface = interface
+        @options   = options
+        @keys      = []
+
+        instance_eval(&block)
+      end
+
+      def key(key_name, params = {})
+        prevent_key_rewrite!(key_name)
+
+        keys << Interface::Key.new(key_name, params.merge(group: name, interface: interface))
+        keys
+      end
+
+      def ui_keys
+        keys.select(&:ui?)
+      end
+
+      def store(backend)
+        Ez::Settings::Store.new(self, backend)
+      end
+
+      private
+
+      def prevent_key_rewrite!(key_name)
+        return unless keys.map(&:name).include?(key_name)
+
+        raise OverwriteKeyError, "Key #{key_name} already registred in #{name} group"
+      end
+    end
+  end
+end

data/lib/ez/settings/interface/key.rb

@@ -0,0 +1,24 @@
+module Ez::Settings
+  class Interface
+    class Key
+      attr_reader :name, :group, :interface, :type, :default,
+                  :ui, :required, :collection, :options
+
+      def initialize(name, params)
+        @name       = name
+        @group      = params.fetch(:group)
+        @interface  = params.fetch(:interface)
+        @type       = params.fetch(:type, :string)
+        @default    = params.fetch(:default, -> {}).call
+        @ui         = params.fetch(:ui, true)
+        @required   = params.fetch(:required, true)
+        @collection = params.fetch(:collection, [])
+        @options    = params.fetch(:options, {})
+      end
+
+      # Alias all boolean-like options to predicates methods, please
+      alias_method :ui?,       :ui
+      alias_method :required?, :required
+    end
+  end
+end

data/lib/ez/settings/request_dispatcher.rb

@@ -0,0 +1,19 @@
+module Ez
+  module Settings
+    module RequestDispatcher
+      # should implement :params
+
+      def interface
+        # TODO: add raise exception in nil
+        Ez::Registry.data(:settings_interfaces).find do |interface|
+          interface.name ==  params[:interface].to_sym
+        end
+      end
+
+      def group
+        # TODO: add raise exception if nil
+        interface.groups.find { |g| g.name == params[:group].to_sym }
+      end
+    end
+  end
+end

data/lib/ez/settings/routes.rb

@@ -0,0 +1,7 @@
+class ActionDispatch::Routing::Mapper
+  def ez_settings_for(interface)
+    defaults interface: interface do
+      mount Ez::Settings::Engine, at: '/settings', as: :ez_settings
+    end
+  end
+end

data/lib/ez/settings/store.rb

@@ -0,0 +1,80 @@
+require 'active_model'
+
+require 'ez/settings/config'
+
+module Ez::Settings
+  class Store
+    delegate :keys, to: :group
+
+    attr_reader :group, :errors, :backend
+
+    def initialize(group, backend)
+      @group   = group
+      @errors  = ActiveModel::Errors.new(self)
+      @backend = backend
+
+      define_accessors
+
+      keys.each { |key| default_or_exists_value(data, key) }
+    end
+
+    def validate
+      @errors = ActiveModel::Errors.new(self)
+
+      group.keys.select(&:required?).each do |key|
+        errors.add(key.name, "can't be blank") if self.send(key.name).blank?
+      end
+    end
+
+    def valid?
+      errors.empty?
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def update(params)
+      params.each { |key, value| self.public_send("#{key}=", value) }
+
+      validate
+      return self unless errors.empty?
+
+      backend.write(schema)
+
+      self
+    end
+
+    def schema
+      {
+        group.name => group.keys.map(&:name).each_with_object({}) do |key_name, schema|
+          schema[key_name] = send(key_name)
+        end
+      }
+    end
+
+    private
+
+    def default_or_exists_value(from_data, key)
+      value = from_data[key.name].nil? ? key.default : from_data[key.name]
+
+      public_send("#{key.name}=", value)
+    end
+
+    def data
+      @data ||= backend.read[group.name] || {}
+    end
+
+    def define_accessors
+      group.keys.map(&:name).each do |name|
+        define_singleton_method(name) do
+          instance_variable_get("@#{name}")
+        end
+
+        define_singleton_method("#{name}=") do |value|
+          instance_variable_set("@#{name}", value)
+        end
+      end
+    end
+  end
+end

data/lib/ez/settings/version.rb

@@ -0,0 +1,5 @@
+module Ez
+  module Settings
+    VERSION = '0.1.0'
+  end
+end

data/lib/generators/ez/settings/install_generator.rb

@@ -0,0 +1 @@
+# TODO @VS [0.2]

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: ez-settings
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Volodya Sveredyuk
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-06-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ez-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: cells-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.8
+- !ruby/object:Gem::Dependency
+  name: cells-slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.0.5
+- !ruby/object:Gem::Dependency
+  name: simple_form
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.5.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: launchy
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Easy settings engine for Rails app.
+email:
+- sveredyuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/ez_settings_manifest.js
+- app/assets/javascripts/ez/settings/application.js
+- app/assets/stylesheets/ez/settings/application.css
+- app/cells/ez/settings/base_cell.rb
+- app/cells/ez/settings/group/show.slim
+- app/cells/ez/settings/group_cell.rb
+- app/cells/ez/settings/index/show.slim
+- app/cells/ez/settings/index_cell.rb
+- app/cells/ez/settings/key/show.slim
+- app/cells/ez/settings/key_cell.rb
+- app/cells/ez/settings/nav/show.slim
+- app/cells/ez/settings/nav_cell.rb
+- app/controllers/ez/settings/application_controller.rb
+- app/controllers/ez/settings/settings_controller.rb
+- app/helpers/ez/settings/application_helper.rb
+- app/models/ez/settings/application_record.rb
+- config/routes.rb
+- lib/ez/settings.rb
+- lib/ez/settings/accessors.rb
+- lib/ez/settings/backend/file_system.rb
+- lib/ez/settings/config.rb
+- lib/ez/settings/engine.rb
+- lib/ez/settings/interface.rb
+- lib/ez/settings/interface/group.rb
+- lib/ez/settings/interface/key.rb
+- lib/ez/settings/request_dispatcher.rb
+- lib/ez/settings/routes.rb
+- lib/ez/settings/store.rb
+- lib/ez/settings/version.rb
+- lib/generators/ez/settings/install_generator.rb
+homepage: https://github.com/ez-engines
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Easy settings engine for Rails app.
+test_files: []