bizarroids_settings 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59811ae2e4943af1f4bf06dd4dd10bbda512d03b
+  data.tar.gz: ded645fc5f175f9bd39aeac14e46ccce006e8404
+SHA512:
+  metadata.gz: bf46de55f1db8143b409d49af36218308457460062735ea4e340e922d9341f84ae642fc9812848537ebb43fe14aa19d93851a2ac31c14743ed223200edbf0e43
+  data.tar.gz: 922087c719a1306aefb58e7ff372394fb0073fbb9e9dd529bba1686ad539a2d3152fcdf399bd21042d781b1fc0cbfb794f77cc353e1302967e7cc1b77e42af37

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2014 Corlinus
+
+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.rdoc

@@ -0,0 +1,77 @@
+= Bizarroids Settings
+
+Flexible settings for Rails application. This is a part of The Bizarroids.
+
+== Installation
+
+Add it to your Gemfile:
+
+  gem 'bizarroids_settings'
+
+Run the following command to install it:
+
+  bundle install
+
+Run the generator:
+
+  rails generate bizarroids:settings:install
+
+== Configuraton
+
+Edit +config/initialisers/bizarroids_settings.rb+. You can create options using folowing syntax:
+
+  config.option :key, :string, value: 'MyString', other: :options
+
+Avaliable types:
+
+- string
+- integer
+- float
+- boolean
+- text
+- date
+- datetime
+- file
+
+Avaliable options:
+
+* name - gives user readable name to the option. It would be show in admin panel.
+* description - description to show in admin panel.
+* require - if set true, prevents user to set empty value.
+* hidden - if set true, hides option from user in admin panel.
+* collection - (+collection: [1, 2, 3]+) forses user to select given values instead of enter in input field.
+
+Some additional configuration can be found +config/initialisers/bizarroids_settings.rb+
+
+== Usage
+
+Link for admin panel
+
+  bizarroids_settings_menu_link
+
+If you use cancancan place in your ability.rb somthing like
+
+  can :manage, Bizarroids::Settings::Option
+
+if don't, place in config/initialisers/bizarroids_settings.rb
+
+  config.use_cancancan = false
+
+To get value for :key
+
+Get:
+
+  Bizarroids::Settings.get(:key)
+  Bizarroids::Settings[:key]
+
+Set:
+
+  Bizarroids::Settings.get(:key) = 'my value'
+  Bizarroids::Settings[:key] = 'my value'
+
+== TODO
+
+* image styles for file field
+* Tests
+
+This project rocks and uses MIT-LICENSE.

data/Rakefile

@@ -0,0 +1,34 @@
+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    = 'BizarroidsSettings'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/bizarroids/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 vendor/assets/javascripts of plugins, if any, 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.
+//
+// Read Sprockets README (https://github.com/sstephenson/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/bizarroids/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 vendor/assets/stylesheets of plugins, if any, 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 styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

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

@@ -0,0 +1,4 @@
+module Bizarroids::Settings
+  class ApplicationController < parent_controller.constantize
+  end
+end

data/app/controllers/bizarroids/settings/options_controller.rb

@@ -0,0 +1,33 @@
+require_dependency "bizarroids/settings/application_controller"
+
+module Bizarroids::Settings
+  class OptionsController < parent_controller.constantize
+    helper 'bizarroids/settings/options'
+
+    respond_to :html
+    inherit_resources
+    actions :index, :edit, :update
+
+    if Bizarroids::Settings.use_cancancan
+      authorize_resource class: "Bizarroids::Settings::Option", param_method: :permitted_params
+    end
+
+    def update
+      update!(notice: t('bizarroids.settings.option_updated')) { bizarroids_settings_engine.options_url }
+    end
+
+    protected
+
+    def resource
+      @option ||= end_of_association_chain.user_editable.find_by(key: params[:id])
+    end
+
+    def collection
+      @options ||= end_of_association_chain.user_editable
+    end
+
+    def permitted_params
+      params.permit(bizarroids_settings_option: Bizarroids::Settings::VALUE_TYPES.map {|x| :"#{x}_value"} + [:remove_file_value])
+    end
+  end
+end

data/app/helpers/bizarroids/settings/options_helper.rb

@@ -0,0 +1,15 @@
+module Bizarroids::Settings::OptionsHelper
+  def bizarroids_settings_input_options custom_options={}
+    key = @option.sym_key
+    {
+      label: @option.human_name,
+      required: @option.required,
+      input_html: { class: Bizarroids::Settings.options[key][:input_class] },
+      collection: @option.collection? ? bizarroids_settings_select_collection(key) : nil
+    }.merge custom_options
+  end
+
+  def bizarroids_settings_select_collection key
+    Bizarroids::Settings.options[key][:collection]
+  end
+end

data/app/helpers/bizarroids/settings/settings_helper.rb

@@ -0,0 +1,27 @@
+module Bizarroids::Settings
+  module SettingsHelper
+    def bizarroids_edit_button path
+      link_to path, class: 'btn btn-link btn-xs text-primary' do
+        content_tag :span, '', class: 'glyphicon glyphicon-pencil'
+      end
+    end
+
+    def bizarroids_t key
+      t key, scope: :bizarroids
+    end
+
+    def bizarroids_settings_menu_link
+      link_to bizarroids_t('settings.name'),
+        bizarroids_settings_engine.options_path,
+        class: [bizarroids_settings_menu_link_class, 'list-group-item']
+    end
+
+    def bizarroids_settings_menu_link_class
+      bizarroids_settings_menu_link_active? ? :active : nil
+    end
+
+    def bizarroids_settings_menu_link_active?
+      controller.kind_of?(Bizarroids::Settings::OptionsController)
+    end
+  end
+end

data/app/models/bizarroids/settings/option.rb

@@ -0,0 +1,65 @@
+module Bizarroids::Settings
+  class Option < ActiveRecord::Base
+    validates :key, presence: true, uniqueness: true
+    validates :value_type, presence: true, inclusion: { in: Bizarroids::Settings::VALUE_TYPES }
+
+    mount_uploader :file_value, ::Bizarroids::Settings::OptionUploader
+
+    def self.active_attr attr_name
+      :"#{attr_name}_value"
+    end
+
+    Bizarroids::Settings::VALUE_TYPES.each do |type|
+      # validates :string_value, presence: true, if: "value_type == 'string' && required?"
+      validates self.active_attr(type), presence: true, if: "value_type == '#{type}' && required?"
+    end
+
+    scope :visible, -> { where hidden: false }
+    scope :actual, -> { where key: Bizarroids::Settings.keys }
+    scope :user_editable, -> { actual.visible }
+    scope :default_order, -> { order :position }
+    default_scope -> { default_order }
+
+    def to_param
+      key
+    end
+
+    def sym_key
+      key.to_sym
+    end
+
+    def active_attr
+      self.class.active_attr value_type
+    end
+
+    def get_value
+      send active_attr
+    end
+
+    def set_value val
+      update_attributes value: val
+    end
+
+    def avaliable_values
+      Bizarroids::Settings.options[sym_key][:collection]
+    end
+
+    def human_name
+      name || key.humanize
+    end
+
+    def human_type
+      I18n.t value_type, scope: 'bizarroids.settings.types'
+    end
+
+    attr_accessor :value
+
+    before_validation do
+      self.value_type = self.value_type.to_s
+
+      if value.present?
+        send :"#{active_attr}=", self.value
+      end
+    end
+  end
+end

data/app/views/bizarroids/settings/options/edit.html.erb

@@ -0,0 +1,21 @@
+<%= content_for :page_header do %>
+  <h1>
+    <%= bizarroids_t 'settings.name' %>
+    <small><%= bizarroids_t :edit %> &mdash; <%= @option.human_name %></small>
+  </h1>
+<% end %>
+
+<div class='well'>
+  <%= simple_form_for @option, url: bizarroids_settings_engine.option_path(@option), html: { class: 'form-horizontal' } do |f| %>
+    <%= f.input @option.active_attr, bizarroids_settings_input_options %>
+    <% if @option.value_type == 'file' %>
+      <%= f.input :remove_file_value, as: :boolean %>
+    <% end %>
+    <div class='form-group'>
+      <div class='col-lg-offset-2 col-lg-10'>
+        <%= f.submit bizarroids_t(:save), class: 'btn btn-primary' %>
+        <%= link_to bizarroids_t(:cancel), bizarroids_settings_engine.options_path, class: 'btn btn-link' %>
+      </div>
+    </div>
+  <% end %>
+</div>

data/app/views/bizarroids/settings/options/index.html.erb

@@ -0,0 +1,42 @@
+<%= content_for :page_header do %>
+  <h1><%= bizarroids_t 'settings.name' %></h1>
+<% end %>
+
+<table class='table table-bordered table-striped'>
+  <thead>
+    <tr>
+      <% %i(name value_type value).each do |attr_name| %>
+        <th><%= resource_class.human_attribute_name(attr_name) %></th>
+      <% end %>
+      <th>&nbsp;</th>
+    </tr>
+  </thead>
+  <tbody>
+    <% @options.each do |option| %>
+      <tr>
+        <td>
+          <%= link_to option.human_name, bizarroids_settings_engine.edit_option_path(option) %>
+          <% if option.description.present? %>
+            <br/><em><%= option.description %></em>
+          <% end %>
+        </td>
+        <td><%= option.human_type %></td>
+        <td>
+          <% if option.get_value.present? %>
+            <% case option.value_type %>
+            <% when 'date', 'datetime' %>
+              <%= l option.get_value, format: :long %>
+            <% when 'file' %>
+              <%= link_to h(truncate(File.basename(option.get_value.path), length: 30)), option.get_value.url, target: :_blank %>
+            <% else %>
+              <%= option.get_value %>
+            <% end %>
+          <% else %>
+            <em><%= bizarroids_t :not_set %></em>
+          <% end %>
+        </td>
+        <td class='text-right'><%= bizarroids_edit_button bizarroids_settings_engine.edit_option_path(option) %></td>
+      </tr>
+    <% end %>
+  </tbody>
+</table>

data/app/views/layouts/bizarroids/settings/application.html.erb

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

data/config/routes.rb

@@ -0,0 +1,7 @@
+Bizarroids::Settings::Engine.routes.draw do
+  scope module: :bizarroids do
+    scope module: :settings do
+      resources :options, only: %i(index edit update)
+    end
+  end
+end

data/db/schema.rb

@@ -0,0 +1,38 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended that you check this file into your version control system.
+
+ActiveRecord::Schema.define(version: 20140728085200) do
+
+  create_table "bizarroids_settings_options", force: true do |t|
+    t.string   "key"
+    t.string   "value_type",     limit: 10
+    t.string   "name"
+    t.string   "description"
+    t.boolean  "required",                  default: false
+    t.boolean  "hidden",                    default: false
+    t.boolean  "collection",                default: false
+    t.integer  "position"
+    t.string   "string_value"
+    t.integer  "integer_value"
+    t.float    "float_value"
+    t.boolean  "boolean_value",             default: false
+    t.text     "text_value"
+    t.date     "date_value"
+    t.datetime "datetime_value"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
+
+  add_index "bizarroids_settings_options", ["key"], name: "index_bizarroids_settings_options_on_key"
+
+end

data/lib/bizarroids/settings/bizarroids_settings_option_uploader.rb

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+module Bizarroids::Settings
+  class OptionUploader < CarrierWave::Uploader::Base
+    include CarrierWave::MiniMagick
+
+    storage :file
+
+    def store_dir
+      File.join Bizarroids::Settings.files_storage_dir, model.key
+    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
+
+    def extension_white_list
+      Bizarroids::Settings.options[model.sym_key][:extension_white_list]
+    end
+  end
+end

data/lib/bizarroids/settings/config_error.rb

@@ -0,0 +1,4 @@
+module Bizarroids::Settings
+  class ConfigError < StandardError
+  end
+end

data/lib/bizarroids/settings/engine.rb

@@ -0,0 +1,7 @@
+require 'bizarroids/settings/helpers/settings_helper'
+module Bizarroids
+  module Settings
+    class Engine < ::Rails::Engine
+    end
+  end
+end

data/lib/bizarroids/settings/helpers/settings_helper.rb

@@ -0,0 +1,27 @@
+module Bizarroids::Settings
+  module SettingsHelper
+    def bizarroids_edit_button path
+      link_to path, class: 'btn btn-link btn-xs text-primary' do
+        content_tag :span, '', class: 'glyphicon glyphicon-pencil'
+      end
+    end
+
+    def bizarroids_t key
+      t key, scope: :bizarroids
+    end
+
+    def bizarroids_settings_menu_link
+      link_to Bizarroids::Settings::Option.model_name.human(count: 10),
+        bizarroids_settings_engine.options_path,
+        class: bizarroids_settings_menu_link_class
+    end
+
+    def bizarroids_settings_menu_link_class
+      bizarroids_settings_menu_link_active? ? :active : nil
+    end
+
+    def bizarroids_settings_menu_link_active?
+      controller.kind_of?(Bizarroids::Settings::OptionsController)
+    end
+  end
+end

data/lib/bizarroids/settings/version.rb

@@ -0,0 +1,5 @@
+module Bizarroids
+  module Settings
+    VERSION = "0.1.2".freeze
+  end
+end

data/lib/bizarroids/settings.rb

@@ -0,0 +1,123 @@
+require 'cancancan'
+require 'inherited_resources'
+require 'simple_form'
+require 'mini_magick'
+require 'carrierwave'
+
+require 'bizarroids/settings/helpers/settings_helper'
+require 'bizarroids/settings/engine'
+require 'bizarroids/settings/config_error'
+require 'bizarroids/settings/bizarroids_settings_option_uploader'
+
+module Bizarroids
+  module Settings
+    # name prefix for ActiveRecord
+    def self.table_name_prefix
+      'bizarroids_settings_'
+    end
+
+    VALUE_TYPES = %w(string integer float boolean text date datetime file).freeze
+
+    def self.get key
+      raise ActiveRecord::RecordNotFound.new("Option ':#{key}' not defined") unless key.in? keys
+      Option.find_by!(key: key).try :get_value
+    end
+
+    def self.set key, value
+      raise ActiveRecord::RecordNotFound.new("Option ':#{key}' not defined") unless key.in? keys
+      Option.find_by!(key: key).set_value value
+    end
+
+    class << self
+      alias :[] :get
+      alias :[]= :set
+    end
+
+    mattr_accessor :options
+    @@options = {}
+
+    mattr_accessor :keys
+    @@keys = []
+
+    mattr_accessor :parent_controller
+    @@parent_controller = '::ApplicationController'
+
+    mattr_accessor :use_cancancan
+    @@use_cancancan = true
+
+    mattr_accessor :files_storage_dir
+    @@files_storage_dir = 'system/settings'
+
+    def self.setup
+      yield self
+    end
+
+    private
+
+    def self.option key, type, attrs={}
+      key = key.to_sym
+      type = type.to_sym
+      attrs = attrs.dup
+
+      if options.has_key? key
+        raise ConfigError.new "Option ':#{key}' already exists"
+      end
+
+      if attrs[:required] && attrs[:value].blank?
+        raise ConfigError.new "You must specify :value with required: true"
+      end
+
+      if attrs[:hidden] && attrs[:value].blank?
+        raise ConfigError.new "You must specify :value with hidden: true"
+      end
+
+      if attrs[:collection].present? && !attrs[:collection].kind_of?(Array)
+        raise ConfigError.new ":collection option must be an array"
+      end
+
+      options[key] = attrs.merge type: type
+      keys << key
+
+      # skip creating if table is not exists
+      return unless ActiveRecord::Base.connection.table_exists? Option.table_name
+
+      attrs[:collection] = !!attrs[:collection]
+      attrs[:position] = keys.index(key)
+
+      option = Option.find_by key: key
+
+      if option.present?
+        if option.value_type.to_sym != type
+          # replace option if type changed
+          option.destroy
+          option = nil
+        else
+          option.update_attributes attrs_for_update(attrs)
+          return option
+        end
+      end
+
+      if option.blank?
+        option = Option.create! attrs_for_create(key, type, attrs)
+      end
+
+      option
+    end
+
+    def self.attrs_for_create key, type, attrs
+      attrs.merge(key: key, value_type: type).slice *valid_attr_names
+    end
+
+    def self.attrs_for_update attrs
+      attrs.slice *auto_update_attr_names
+    end
+
+    def self.auto_update_attr_names
+      %i(name description required hidden collection position)
+    end
+
+    def self.valid_attr_names
+      auto_update_attr_names + %i(key value_type value)
+    end
+  end
+end

data/lib/bizarroids.rb

@@ -0,0 +1,4 @@
+require "bizarroids/settings"
+
+module Bizarroids
+end

data/lib/bizarroids_settings.rb

@@ -0,0 +1 @@
+require 'bizarroids'

data/lib/generators/bizarroids/settings/install/USAGE

@@ -0,0 +1,14 @@
+Description:
+    It will create a migration file
+
+Example:
+    rails generate bizarroids:settings:install
+
+    This will create:
+        db/migrate/create_bizarroids_settings_options_table.rb
+        config/initialiser/bizarroids_settings.rb
+        config/locales/bizarroids_settings.en.yml
+        config/locales/bizarroids_settings.ru.yml
+
+    This will add:
+        routes to config/routes.rb