simple_cached_settings 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c2533551bbe3c9613ec7d70cbfcdf24ef00adfd5
+  data.tar.gz: b4b3a84e74d923a520970ad747b21f86f581d850
+SHA512:
+  metadata.gz: 8de5cfecd0aebd326d15e91bd1c7335481af464172f4ce6a1e3fa86b5bef3ff76a71e6d143236e4c7105f634a488f37ff746a0de261c7a7641c73ed2f30f414e
+  data.tar.gz: 85fb1bf5a47475be69a25c087347b97615df8460bbd23996a493f4bfa74e04d98c5ce2112d3bd476021c5bb8ef98dab482deff2290629735525187aa3c9a3730

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in settings.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Le6ow5k1
+
+MIT License
+
+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,53 @@
+# Simple Cached Settings
+
+Gem for storing global configuration settings in an ActiveRecord::Model.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_cached_settings'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_cached_settings
+
+## Setup
+
+Generate settings model and migration:
+
+    $ rails g simple_cached_settings <settings_name>
+
+Apply migration:
+    
+    $ rake db:migrate
+
+Now you have the model that looks something like this:
+
+```ruby
+class MySettings < SimpleCachedSettings::Settings
+end
+```
+
+## Usage
+
+```ruby
+MySettings.write(:foo, 'bar')
+
+MySettings.read(:foo)
+=> 'bar'
+```
+
+It's possible to store settings values of four types: String, Integer, Float and Boolean
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/settings/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/simple_cached_settings/simple_cached_settings_generator.rb

@@ -0,0 +1,29 @@
+require 'rails/generators/migration'
+
+class SimpleCachedSettingsGenerator < Rails::Generators::NamedBase
+  include Rails::Generators::Migration
+
+  argument :name, type: :string, default: 'my_settings'
+
+  source_root File.expand_path('../templates', __FILE__)
+
+  @@migrations = false
+
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      if @@migrations
+        (current_migration_number(dirname) + 1)
+      else
+        @@migrations = true
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+    else
+      '%.3d' % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def settings
+    template 'model.rb', File.join('app/models', class_path, "#{file_name}.rb"), force: true
+    migration_template 'migration.rb', 'db/migrate/create_settings.rb'
+  end
+end

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

@@ -0,0 +1,9 @@
+class CreateSettings < ActiveRecord::Migration
+  def change
+    create_table :settings do |t|
+      t.string :key, null: false
+      t.text :value
+      t.timestamps null: false
+    end
+  end
+end

data/lib/generators/simple_cached_settings/templates/model.rb

@@ -0,0 +1,2 @@
+class <%= class_name %> < SimpleCachedSettings::Settings
+end

data/lib/simple_cached_settings.rb

@@ -0,0 +1,3 @@
+require 'simple_cached_settings/version'
+require 'simple_cached_settings/setting_serializer'
+require 'simple_cached_settings/settings'

data/lib/simple_cached_settings/setting_serializer.rb

@@ -0,0 +1,21 @@
+module SimpleCachedSettings
+  class SettingSerializer
+    ALLOWED_VALUE_TYPES = [Fixnum, String, Float, TrueClass, FalseClass]
+
+    class SettingTypeNotAllowed < TypeError; end
+
+    class << self
+      def load(value)
+        YAML.load(value) if value
+      end
+
+      def dump(value)
+        if ALLOWED_VALUE_TYPES.any? { |t| value.is_a?(t) }
+          YAML.dump(value)
+        else
+          raise SettingTypeNotAllowed, "Setting values of type #{value.class} not allowed"
+        end
+      end
+    end
+  end
+end

data/lib/simple_cached_settings/settings.rb

@@ -0,0 +1,39 @@
+module SimpleCachedSettings
+  class Settings < ActiveRecord::Base
+    self.table_name = 'settings'
+
+    validates :key, uniqueness: true
+
+    serialize :value, SettingSerializer
+
+    class << self
+      def write(key, value)
+        setting = find_or_initialize_by(key: key)
+        setting.value = value
+        setting.save
+      end
+
+      def read(key)
+        value = Rails.cache.read(__cache_key(key))
+        return value if value
+
+        setting = find_by(key: key)
+        setting.value if setting
+      end
+
+      def __cache_key(setting_key)
+        "simple_settings:#{setting_key}"
+      end
+    end
+
+    after_commit :update_cache, on: [:create, :update]
+    def update_cache
+      Rails.cache.write(self.class.__cache_key(key), value)
+    end
+
+    after_commit :expire_cache, on: [:destroy]
+    def expire_cache
+      Rails.cache.delete(self.class.__cache_key(key))
+    end
+  end
+end

data/lib/simple_cached_settings/version.rb

@@ -0,0 +1,3 @@
+module SimpleCachedSettings
+  VERSION = '0.1.1'
+end

data/settings.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'simple_cached_settings/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'simple_cached_settings'
+  spec.version       = SimpleCachedSettings::VERSION
+  spec.authors       = ['Le6ow5k1']
+  spec.email         = ['Le6oww5k1@gmail.com']
+  spec.summary       = %q{Gem for storing global configuration settings in an ActiveRecord::Model}
+  spec.homepage      = 'https://github.com/Le6ow5k1/simple_cached_settings'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec-rails'
+  spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'rails', '>= 4.0.0'
+end

data/spec/simple_settings/settings_spec.rb

@@ -0,0 +1,52 @@
+require 'spec_helper'
+
+describe MySettings do
+  describe '.write' do
+    context 'when row with this key does not exist' do
+      it 'creates new instance of Settings model' do
+        expect { described_class.write(:god_mode, true) }.to change { described_class.count }.by(1)
+      end
+
+      it 'saves instance with right key and value fields' do
+        described_class.write(:god_mode, true)
+        setting = described_class.find_by(key: :god_mode)
+
+        expect(setting.key).to eq('god_mode')
+        expect(setting.value).to be true
+      end
+    end
+
+    context 'when row with this key exist' do
+      before do
+        @setting = described_class.create(key: :password, value: 'qwerty')
+      end
+
+      it 'does not create new instance of Settings model' do
+        expect { described_class.write(@setting.key, '123') }.to_not change { described_class.count }
+      end
+
+      it 'updates value of existing Settings model' do
+        described_class.write(@setting.key, '1')
+        expect(@setting.reload.value).to eq('1')
+      end
+    end
+  end
+
+  describe '.read' do
+    context 'when there is a setting with such key' do
+      before do
+        @setting = described_class.create(key: :number, value: 10)
+      end
+
+      it 'returns value of that setting' do
+        expect(described_class.read(@setting.key)).to eq(@setting.value)
+      end
+    end
+
+    context 'when there is no setting with such key' do
+      it 'returns nil' do
+        expect(described_class.read(:non_existing_key)).to be nil
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,57 @@
+require 'rubygems'
+require 'active_record'
+require 'active_support'
+require 'sqlite3'
+require 'database_cleaner'
+require 'rails/railtie'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'rails'))
+require 'simple_settings'
+
+ActiveRecord::Base.establish_connection(adapter: 'sqlite3', database: ':memory:')
+ActiveRecord::Schema.verbose = false
+ActiveRecord::Schema.define(version: 1) do
+  create_table :settings do |t|
+    t.string :key, null: false
+    t.text :value
+    t.timestamps null: false
+  end
+end
+
+module Rails
+  def self.cache
+    @cache ||= ActiveSupport::Cache::MemoryStore.new
+  end
+end
+
+class ::MySettings < SimpleSettings::Settings
+  self.table_name = 'settings'
+end
+
+RSpec.configure do |config|
+  config.warnings = false
+
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.before(:suite) do
+    DatabaseCleaner.strategy = :transaction
+    DatabaseCleaner.clean_with(:truncation)
+  end
+
+  config.around(:each) do |example|
+    DatabaseCleaner.cleaning do
+      example.run
+    end
+  end
+
+  config.before(:all) do
+    Rails.cache.clear
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: simple_cached_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Le6ow5k1
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: factory_girl
+  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: 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: database_cleaner
+  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: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: 
+email:
+- Le6oww5k1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/simple_cached_settings/simple_cached_settings_generator.rb
+- lib/generators/simple_cached_settings/templates/migration.rb
+- lib/generators/simple_cached_settings/templates/model.rb
+- lib/simple_cached_settings.rb
+- lib/simple_cached_settings/setting_serializer.rb
+- lib/simple_cached_settings/settings.rb
+- lib/simple_cached_settings/version.rb
+- settings.gemspec
+- spec/simple_settings/settings_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/Le6ow5k1/simple_cached_settings
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for storing global configuration settings in an ActiveRecord::Model
+test_files:
+- spec/simple_settings/settings_spec.rb
+- spec/spec_helper.rb