rails_admin_settings 0.8.0 → 0.9.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ce97b11e2293752dd5d9ed40d1131007eb075a5
-  data.tar.gz: 032aa4f2f688f79693520122ed3e07482a32e1d3
+  metadata.gz: 77ff229c1b71b0265ce4d23d2da8853c6cbb9203
+  data.tar.gz: d86ab6c49fefb97a5582a1b7d1c13c2c6d568f66
 SHA512:
-  metadata.gz: 89fbb7b656fcb7eedde0c17971ed25486e0d52a4866a1c994c68529badf8d90880f437fa9e92f764bfc582f8e3616f0c3052e9a6a2dff060377867bab605e5d8
-  data.tar.gz: 7c774324d9fa3a61de6c17591521e857d98cb1d42a87320cadba75885a52e0ed5675f0f9dfdd0c31774e34b156db591d82d39b171587be3393ca477246fa36ba
+  metadata.gz: 31ea6d4cad521443024a0572e8cb3b10b7488d4afe9e5bb3da691aa31d9b0034f6282891af3e9928d046aa69b20432ac6ba47ca8e4e0d9fd2f1100aa326437bf
+  data.tar.gz: c1d935b38d5564e0cf5514b8180807f5adbe27adcf95c5a76649c2f8f8c764c89eb509f96422b1306c801fcbab719fdac8f23b544e67397d68abc61c0d16fe48

data/.ruby-version

@@ -1,2 +1 @@
-2.1.2
-
+2.1.3

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.9.0
+
+- Added ActiveRecord support
+- [!!!] Type renamed to Kind to avoid messing with AR STI column
+
 ## 0.6.0
 
 - Added namespaced settings

data/Gemfile.lock

@@ -1,19 +1,40 @@
 PATH
   remote: .
   specs:
-    rails_admin_settings (0.8.0)
-      mongoid (>= 3.0, < 4.1)
+    rails_admin_settings (0.9.0.pre)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    actionmailer (3.2.19)
+      actionpack (= 3.2.19)
+      mail (~> 2.5.4)
+    actionpack (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      builder (~> 3.0.0)
+      erubis (~> 2.7.0)
+      journey (~> 1.0.4)
+      rack (~> 1.4.5)
+      rack-cache (~> 1.2)
+      rack-test (~> 0.6.1)
+      sprockets (~> 2.2.1)
     activemodel (3.2.19)
       activesupport (= 3.2.19)
       builder (~> 3.0.0)
+    activerecord (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
+      arel (~> 3.0.2)
+      tzinfo (~> 0.3.29)
+    activeresource (3.2.19)
+      activemodel (= 3.2.19)
+      activesupport (= 3.2.19)
     activesupport (3.2.19)
       i18n (~> 0.6, >= 0.6.4)
       multi_json (~> 1.0)
     addressable (2.3.6)
+    arel (3.0.3)
     builder (3.0.4)
     carrierwave (0.10.0)
       activemodel (>= 3.2.0)
@@ -29,19 +50,25 @@ GEM
     database_cleaner (1.3.0)
     diff-lcs (1.2.5)
     docile (1.1.5)
+    erubis (2.7.0)
     factory_girl (4.4.0)
       activesupport (>= 3.0.0)
-    geocoder (1.2.3)
+    geocoder (1.2.5)
     glebtv-carrierwave-mongoid (0.8.0)
       carrierwave (>= 0.8.0, < 0.11.0)
       mongoid (>= 3.0, < 5.0)
     glebtv-mongoid-paperclip (0.2.4)
       mongoid (>= 3.0, < 5.0)
       paperclip (>= 2.3.6)
+    hike (1.2.3)
     i18n (0.6.11)
+    journey (1.0.4)
     json (1.8.1)
+    mail (2.5.4)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
     method_source (0.8.2)
-    mime-types (2.3)
+    mime-types (1.25.1)
     mini_portile (0.6.0)
     mongoid (3.1.6)
       activemodel (~> 3.2)
@@ -56,7 +83,7 @@ GEM
     multi_json (1.10.1)
     nokogiri (1.6.3.1)
       mini_portile (= 0.6.0)
-    nokogumbo (1.1.9)
+    nokogumbo (1.1.12)
       nokogiri
     origin (1.1.0)
     paperclip (4.2.0)
@@ -64,38 +91,160 @@ GEM
       activesupport (>= 3.0.0)
       cocaine (~> 0.5.3)
       mime-types
-    pry (0.10.0)
+    polyglot (0.3.5)
+    pry (0.10.1)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    rack (1.4.5)
+    rack-cache (1.2)
+      rack (>= 0.4)
+    rack-ssl (1.3.4)
+      rack
+    rack-test (0.6.2)
+      rack (>= 1.0)
+    rails (3.2.19)
+      actionmailer (= 3.2.19)
+      actionpack (= 3.2.19)
+      activerecord (= 3.2.19)
+      activeresource (= 3.2.19)
+      activesupport (= 3.2.19)
+      bundler (~> 1.0)
+      railties (= 3.2.19)
+    railties (3.2.19)
+      actionpack (= 3.2.19)
+      activesupport (= 3.2.19)
+      rack-ssl (~> 1.3.2)
+      rake (>= 0.8.7)
+      rdoc (~> 3.4)
+      thor (>= 0.14.6, < 2.0)
     rake (10.3.2)
-    rspec (3.0.0)
-      rspec-core (~> 3.0.0)
-      rspec-expectations (~> 3.0.0)
-      rspec-mocks (~> 3.0.0)
-    rspec-core (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-expectations (3.0.3)
+    rdoc (3.12.2)
+      json (~> 1.4)
+    rspec (3.1.0)
+      rspec-core (~> 3.1.0)
+      rspec-expectations (~> 3.1.0)
+      rspec-mocks (~> 3.1.0)
+    rspec-core (3.1.4)
+      rspec-support (~> 3.1.0)
+    rspec-expectations (3.1.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.0.0)
-    rspec-mocks (3.0.3)
-      rspec-support (~> 3.0.0)
-    rspec-support (3.0.3)
+      rspec-support (~> 3.1.0)
+    rspec-mocks (3.1.1)
+      rspec-support (~> 3.1.0)
+    rspec-support (3.1.0)
     russian_phone (0.4.1)
       mongoid (>= 3.0.0)
     safe_yaml (1.0.3)
-    sanitize (3.0.0)
+    sanitize (3.0.2)
       crass (~> 0.2.0)
       nokogiri (>= 1.4.4)
-      nokogumbo (= 1.1.9)
-    simplecov (0.9.0)
+      nokogumbo (= 1.1.12)
+    simplecov (0.9.1)
       docile (~> 1.1.0)
-      multi_json
+      multi_json (~> 1.0)
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
     slop (3.6.0)
+    sprockets (2.2.2)
+      hike (~> 1.2)
+      multi_json (~> 1.0)
+      rack (~> 1.0)
+      tilt (~> 1.1, != 1.3.0)
+    thor (0.19.1)
+    tilt (1.4.1)
+    treetop (1.4.15)
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
+      polyglot (>= 0.3.1)
     tzinfo (0.3.41)
-    validates_email_format_of (1.5.3)
+    validates_email_format_of (1.6.1)
+      i18n
 
 PLATFORMS
   ruby
@@ -108,8 +257,10 @@ DEPENDENCIES
   geocoder
   glebtv-carrierwave-mongoid
   glebtv-mongoid-paperclip
+  mongoid (>= 3.0, < 4.1)
   mongoid-rspec
   pry
+  rails
   rails_admin_settings!
   rake
   rspec

data/README.md

@@ -7,12 +7,19 @@ Note: This gem currently supports Mongoid 3/4 only, as I don't need AR support.
 
 Pull request with AR support will be welcome
 
+## 0.9.0 is not backwards-compatible with 0.8
+
+Type renamed to Kind to avoid messing with AR STI column
+Column should be renamed automatically upon first app startup with new gem version.
+
+Also, active record is now supported in addition to mongoid.
+
 ## Features
 
 - Lazy loading - loads settings only if they are needed during request
 - Loads all settings at once and caches them for the duration of request
-- Supports lots of setting types - yaml, html with ckeditor, phone numbers etc
-- Each setting can be enabled and disabled within rails_admin, if it's disabled it returns default value for type
+- Supports lots of setting kinds - yaml, html with ckeditor, phone numbers etc
+- Each setting can be enabled and disabled within rails_admin, if it's disabled it returns default value for kind
 
 ## Installation
 
@@ -20,6 +27,14 @@ Add this line to your application's Gemfile:
 
     gem 'rails_admin_settings'
 
+For activerecord, generage migration:
+
+    rails g rails_admin_settings:migration
+
+Then migrate:
+
+    rake db:migrate
+
 ## Gemfile order matters
 
 - Put it after rails_admin to get built-in support
@@ -49,11 +64,11 @@ Or install it yourself as:
 
 ## Advanced Usage
 
-    Settings.content_block_1(type: 'html', default: 'test')
-    Settings.data(type: 'yaml')
+    Settings.content_block_1(kind: 'html', default: 'test')
+    Settings.data(kind: 'yaml')
     Settings.data = [1, 2, 3]
     
-    Settings.enabled?(:phone, type: 'phone', default: '906 111-11-11') # also creates setting if it doesn't exist
+    Settings.enabled?(:phone, kind: 'phone', default: '906 111-11-11') # also creates setting if it doesn't exist
     Settings.phone.area
     Settings.phone.subscriber
 

data/app/models/rails_admin_settings/setting.rb

@@ -1,23 +1,22 @@
-# coding: utf-8
+if RailsAdminSettings.active_record?
+  module RailsAdminSettings
+    class Setting < ActiveRecord::Base
+    end
+  end
+end
+
 module RailsAdminSettings
   class Setting
-    include ::Mongoid::Document
-    include ::Mongoid::Timestamps::Short
-
-    store_in collection: "rails_admin_settings"
-    
-    field :enabled, type: Mongoid::VERSION.to_i < 4 ? Boolean : Mongoid::Boolean, default: true
-    scope :enabled, -> { where(enabled: true) }
-
-    field :type, type: String, default: RailsAdminSettings.types.first
-
-    field :ns, type: String, default: 'main'
-    field :key, type: String
-    index({ns: 1, key: 1}, {unique: true, sparse: true})
+    #binding.pry
+    if RailsAdminSettings.mongoid?
+      include RailsAdminSettings::Mongoid
+    end
 
-    field :raw, type: String
-    field :label, type: String
+    if RailsAdminSettings.active_record?
+      self.table_name = "rails_admin_settings"
+    end
 
+    scope :enabled, -> { where(enabled: true) }
     scope :ns, ->(ns) { where(ns: ns) }
 
     include RailsAdminSettings::RequireHelpers
@@ -37,6 +36,10 @@ module RailsAdminSettings
       label.blank? ? key : label
     end
 
+    def type
+      kind
+    end
+
     def to_path
       if value.nil?
         nil

data/lib/generators/rails_admin_settings/migration_generator.rb

@@ -0,0 +1,15 @@
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+module RailsAdminSettings
+  class MigrationGenerator < Rails::Generators::Base
+    include ActiveRecord::Generators::Migration
+    source_root File.expand_path('../templates', __FILE__)
+
+    desc 'RocketCMS migration generator'
+    def install
+      migration_template "migration.rb", "db/migrate/create_rails_admin_settings.rb"
+    end
+  end
+end
+

data/lib/generators/rails_admin_settings/templates/migration.rb

@@ -0,0 +1,26 @@
+class CreateRailsAdminSettings < ActiveRecord::Migration
+  def change
+    create_table :rails_admin_settings do |t|
+      t.boolean :enabled, default: true
+      t.string :type, null: false, default: 'string'
+      t.string :ns, default: 'main'
+      t.string :key, null: false
+      if Object.const_defined?('Geocoder')
+        t.float :latitude
+        t.float :longitude
+      end
+      t.text :raw
+      t.string :label
+      if defined?(Paperclip)
+        t.attachment :file
+      elsif defined?(CarrierWave)
+        t.string :file
+      end
+      t.timestamps
+    end
+
+    add_index :rails_admin_settings, :key
+    add_index :rails_admin_settings, [:ns, :key], unique: true
+  end
+end
+

data/lib/rails_admin_settings/engine.rb

@@ -1,5 +1,9 @@
 module RailsAdminSettings
   class Engine < ::Rails::Engine
+    rake_tasks do
+      require File.expand_path('../tasks', __FILE__)
+    end
+
     initializer 'RailsAdminSettings Install after_filter' do |app|
       require File.dirname(__FILE__) + '/../../app/models/rails_admin_settings/setting.rb'
 
@@ -8,8 +12,6 @@ module RailsAdminSettings
           after_filter { Settings.unload! }
         end
       end
-
-      RailsAdminSettings::Setting.where(:ns.exists => false).update_all(ns: 'main')
     end
   end
 end

data/lib/rails_admin_settings/{types.rb → kinds.rb}

@@ -1,5 +1,5 @@
 module RailsAdminSettings
-  def self.types
+  def self.kinds
     [
       'string',
       'text',
@@ -18,4 +18,8 @@ module RailsAdminSettings
       'color'
     ]
   end
+
+  def self.types
+    self.kinds
+  end
 end

data/lib/rails_admin_settings/mongoid.rb

@@ -0,0 +1,19 @@
+module RailsAdminSettings
+  module Mongoid
+    extend ActiveSupport::Concern
+    included do
+      include ::Mongoid::Document
+      include ::Mongoid::Timestamps::Short
+
+      store_in collection: "rails_admin_settings"
+      field :enabled, type: ::Mongoid::VERSION.to_i < 4 ? Boolean : ::Mongoid::Boolean, default: true
+      field :kind, type: String, default: RailsAdminSettings.types.first
+      field :ns, type: String, default: 'main'
+      field :key, type: String
+      field :raw, type: String
+      field :label, type: String
+      index({ns: 1, key: 1}, {unique: true, sparse: true})
+    end
+  end
+end
+

data/lib/rails_admin_settings/namespaced.rb

@@ -133,10 +133,15 @@ module RailsAdminSettings
       elsif key.end_with?('_enabled=')
         key = key[0..-10]
         v = get(key)
-        if ::Mongoid::VERSION >= "4.0.0"
-          v.set(enabled: args.first)
+        if ::RailsAdminSettings.mongoid?
+          if ::Mongoid::VERSION >= "4.0.0"
+            v.set(enabled: args.first)
+          else
+            v.set("enabled", args.first)
+          end
         else
-          v.set("enabled", args.first)
+          v.enabled = args.first
+          v.save!
         end
         v.enabled
       elsif key.end_with?('=')

data/lib/rails_admin_settings/processing.rb

@@ -1,25 +1,31 @@
 module RailsAdminSettings
   module Processing
-    RailsAdminSettings.types.each do |dtype|
-      define_method "#{dtype}_type?" do
-        dtype == type
+    RailsAdminSettings.kinds.each do |dkind|
+      define_method "#{dkind}_kind?" do
+        dkind == kind
+      end
+      define_method "#{dkind}_type?" do
+        dkind == kind
       end
     end
 
-    def text_type?
-      (RailsAdminSettings.types - ['phone', 'phones', 'integer', 'yaml']).include? type
+    def text_kind?
+      (RailsAdminSettings.kinds - ['phone', 'phones', 'integer', 'yaml']).include? kind
     end
 
-    def upload_type?
-      ['file', 'image'].include? type
+    def upload_kind?
+      ['file', 'image'].include? kind
     end
 
-    def html_type?
-      ['html', 'sanitized'].include? type
+    def html_kind?
+      ['html', 'sanitized'].include? kind
     end
+    alias_method :text_type?, :text_kind?
+    alias_method :upload_type?, :upload_kind?
+    alias_method :html_type?, :html_kind?
 
     def value
-      if upload_type?
+      if upload_kind?
         if file?
           file.url
         else
@@ -33,7 +39,7 @@ module RailsAdminSettings
     end
 
     def blank?
-      if file_type?
+      if file_kind?
         file.url.nil?
       elsif raw.blank? || disabled?
         true
@@ -43,7 +49,7 @@ module RailsAdminSettings
     end
 
     def to_s
-      if yaml_type? || phone_type? || integer_type?
+      if yaml_kind? || phone_kind? || integer_kind?
         raw
       else
         value
@@ -59,19 +65,19 @@ module RailsAdminSettings
     end
 
     def default_value
-      if html_type?
+      if html_kind?
         ''.html_safe
-      elsif text_type?
+      elsif text_kind?
         ''
-      elsif integer_type?
+      elsif integer_kind?
         0
-      elsif yaml_type?
+      elsif yaml_kind?
         nil
-      elsif phone_type?
+      elsif phone_kind?
         require_russian_phone do
           RussianPhone::Number.new('')
         end
-      elsif phones_type?
+      elsif phones_kind?
         []
       else
         nil
@@ -79,7 +85,7 @@ module RailsAdminSettings
     end
 
     def default_serializable_value
-      if phones_type?
+      if phones_kind?
         ''
       else
         default_value
@@ -96,7 +102,7 @@ module RailsAdminSettings
           "#{$1}-#{Time.now.strftime('%Y')}"
         end
       end
-      text = text.html_safe if html_type?
+      text = text.html_safe if html_kind?
       text
     end
 
@@ -119,20 +125,20 @@ module RailsAdminSettings
     end
 
     def processed_value
-      if text_type?
+      if text_kind?
         process_text
-      elsif integer_type?
+      elsif integer_kind?
         raw.to_i
-      elsif yaml_type?
+      elsif yaml_kind?
         load_yaml
-      elsif phone_type?
+      elsif phone_kind?
         load_phone
-      elsif phones_type?
+      elsif phones_kind?
         load_phones
-      elsif file_type?
+      elsif file_kind?
         file.url
       else
-        puts "[rails_admin_settings] Unknown field type: #{type}"
+        puts "[rails_admin_settings] Unknown field kind: #{kind}"
         nil
       end
     end

data/lib/rails_admin_settings/rails_admin_config.rb

@@ -11,14 +11,14 @@ module RailsAdminSettings
             else
               field :enabled
             end
-            field :type
+            field :kind
             field :ns
             field :name
             field :raw do
               pretty_value do
-                if bindings[:object].file_type?
+                if bindings[:object].file_kind?
                   "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'>#{CGI::escapeHTML(bindings[:object].to_path)}</a>".html_safe
-                elsif bindings[:object].image_type?
+                elsif bindings[:object].image_kind?
                   "<a href='#{CGI::escapeHTML(bindings[:object].file.url)}'><img src='#{CGI::escapeHTML(bindings[:object].file.url)}' /></a>".html_safe
                 else
                   value
@@ -33,20 +33,20 @@ module RailsAdminSettings
               read_only true
               help false
             end
-            field :type do
+            field :kind do
               read_only true
               help false
             end
             field :raw do
               partial "setting_value"
               visible do
-                !bindings[:object].upload_type?
+                !bindings[:object].upload_kind?
               end
             end
             if Settings.file_uploads_supported
               field :file, Settings.file_uploads_engine do
                 visible do
-                  bindings[:object].upload_type?
+                  bindings[:object].upload_kind?
                 end
               end
             end