settings-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c4e9bce03cd856beb065a25036f6225d8b317cac
+  data.tar.gz: cc8028c3b03979931a15d6fe2e37f64d7f63c783
+SHA512:
+  metadata.gz: 3ef8f7a71b335071449eed1449b036411a42895df4bef168b4d01919d421686f7478ec8e4d6e73472adcc92708352f8ec481fcbe44a6717ede2b570889bb629d
+  data.tar.gz: 30be5fe7ee2f3272ad0b75ea3c2bb7387fa6218e4d01b56ed379fa847dea4f37afe6121ec10f845cae58ee1a1fc297d59a60b3d6836a0dcfca2255f1646ed660

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2015 vala
+
+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/Rakefile

@@ -0,0 +1,26 @@
+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    = 'SettingsRails'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  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'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/assets/javascripts/settings_rails/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.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/settings_rails/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 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/settings_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module SettingsRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/helpers/settings_rails/application_helper.rb

@@ -0,0 +1,4 @@
+module SettingsRails
+  module ApplicationHelper
+  end
+end

data/app/models/settings_rails/float_setting.rb

@@ -0,0 +1,4 @@
+module SettingsRails
+  class FloatSetting < SimpleValueSetting
+  end
+end

data/app/models/settings_rails/integer_setting.rb

@@ -0,0 +1,7 @@
+module SettingsRails
+  class IntegerSetting < SimpleValueSetting
+    def value
+      super.to_i
+    end
+  end
+end

data/app/models/settings_rails/setting.rb

@@ -0,0 +1,27 @@
+module SettingsRails
+  class Setting < ActiveRecord::Base
+    def self.for(type)
+      class_name = class_name_for(type)
+
+      begin
+        class_name.constantize
+      rescue NameError => e
+        e.message = "Setting type does not exist : #{ type } ...\n#{ e.message }"
+        raise e
+      end
+    end
+
+    def self.class_name_for(type)
+      model_name = [type.to_s.camelize, 'Setting'].join
+      ['SettingsRails', model_name].join('::')
+    end
+
+    def _type
+      (type || self.class.name).demodulize.underscore.gsub(/_setting$/, '')
+    end
+
+    def _type=(val)
+      self.type = self.class.class_name_for(val.to_s)
+    end
+  end
+end

data/app/models/settings_rails/simple_value_setting.rb

@@ -0,0 +1,9 @@
+module SettingsRails
+  class SimpleValueSetting < Setting
+    store_accessor :data, :value
+
+    def assign(val)
+      self.value = val
+    end
+  end
+end

data/app/models/settings_rails/string_setting.rb

@@ -0,0 +1,4 @@
+module SettingsRails
+  class StringSetting < SimpleValueSetting
+  end
+end

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

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

data/config/routes.rb

@@ -0,0 +1,2 @@
+SettingsRails::Engine.routes.draw do
+end

data/db/migrate/20150715134533_create_settings_rails_settings.rb

@@ -0,0 +1,12 @@
+class CreateSettingsRailsSettings < ActiveRecord::Migration
+  def change
+    create_table :settings_rails_settings do |t|
+      t.string :key
+      t.json :data
+
+      t.string :type
+
+      t.timestamps null: false
+    end
+  end
+end

data/lib/settings-rails.rb

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

data/lib/settings_rails.rb

@@ -0,0 +1,8 @@
+require "settings_rails/cache"
+require "settings_rails/helper"
+require "settings_rails/form"
+
+require "settings_rails/engine"
+
+module SettingsRails
+end

data/lib/settings_rails/cache.rb

@@ -0,0 +1,29 @@
+module SettingsRails
+  class Cache
+    def self.fetch(key)
+      instance.fetch(key)
+    end
+
+    def self.add(key, setting)
+      instance.store[key] = setting
+    end
+
+    def self.instance
+      RequestStore.store['settings_rails.cache'] ||= new
+    end
+
+    def self.each(&block)
+      instance.store.each(&block)
+    end
+
+    def fetch(key)
+      store[key]
+    end
+
+    def store
+      @store ||= SettingsRails::Setting.all.each_with_object({}.with_indifferent_access) do |setting, hash|
+        hash[setting.key] = setting
+      end
+    end
+  end
+end

data/lib/settings_rails/engine.rb

@@ -0,0 +1,5 @@
+module SettingsRails
+  class Engine < ::Rails::Engine
+    isolate_namespace SettingsRails
+  end
+end

data/lib/settings_rails/form.rb

@@ -0,0 +1,34 @@
+module SettingsRails
+  class Form
+    include ActiveModel::Model
+
+    def settings
+      dirty_settings.values
+    end
+
+    def dirty_settings
+      @dirty_settings ||= {}
+    end
+
+    def settings_attributes=(params)
+      params.each do |_, attributes|
+        setting = Settings.get(attributes[:key], attributes[:_type])
+        setting.assign_attributes(attributes)
+
+        dirty_settings[setting.key] = setting
+      end
+    end
+
+    def save
+      ActiveRecord::Base.transaction do
+        dirty_settings.each do |_, setting|
+          setting.save
+        end
+      end
+    end
+
+    def persisted?
+      true
+    end
+  end
+end

data/lib/settings_rails/helper.rb

@@ -0,0 +1,13 @@
+class Settings
+  class << self
+    def get(key, type = :string)
+      SettingsRails::Cache.fetch(key) || build(key, type)
+    end
+
+    def build(key, type, value = nil)
+      setting = SettingsRails::Setting.for(type).new(key: key, value: value)
+      SettingsRails::Cache.add(key, setting)
+      setting
+    end
+  end
+end

data/lib/settings_rails/version.rb

@@ -0,0 +1,3 @@
+module SettingsRails
+  VERSION = "0.0.1"
+end

data/lib/tasks/settings_rails_tasks.rake

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

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: settings-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Valentin Ballestrino
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: request_store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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'
+description: Rails settings models with multiple data types, allowing db-driven global
+  configuration. PostgreSQL Only.
+email:
+- vala@glyph.fr
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- Rakefile
+- app/assets/javascripts/settings_rails/application.js
+- app/assets/stylesheets/settings_rails/application.css
+- app/controllers/settings_rails/application_controller.rb
+- app/helpers/settings_rails/application_helper.rb
+- app/models/settings_rails/float_setting.rb
+- app/models/settings_rails/integer_setting.rb
+- app/models/settings_rails/setting.rb
+- app/models/settings_rails/simple_value_setting.rb
+- app/models/settings_rails/string_setting.rb
+- app/views/layouts/settings_rails/application.html.erb
+- config/routes.rb
+- db/migrate/20150715134533_create_settings_rails_settings.rb
+- lib/settings-rails.rb
+- lib/settings_rails.rb
+- lib/settings_rails/cache.rb
+- lib/settings_rails/engine.rb
+- lib/settings_rails/form.rb
+- lib/settings_rails/helper.rb
+- lib/settings_rails/version.rb
+- lib/tasks/settings_rails_tasks.rake
+homepage: https://github.com/glyph-fr/settings-rails
+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.4.4
+signing_key: 
+specification_version: 4
+summary: Rails settings models with multiple data types, allowing db-driven global
+  configuration. PostgreSQL Only.
+test_files: []