groupped_settings 0.1.2.18705

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2bed51ae93461d3771be203dbdcbcd6dc2554ab3856833c23c080b7d1c57821f
+  data.tar.gz: 5bcf893e30ec6e03ea6a2a5402e1dbd010e6297fad178302895db3f19e3f2959
+SHA512:
+  metadata.gz: 999b547cf4a69178958b0e1d5dfe20440ce44349102b3375be345aee47b42d79b30c88e82a6505e43ccbaeadb1f76564ca83f196d754095fbe4850c6c0dcba45
+  data.tar.gz: 7550fe33af67f8b29b6b0a484d5e4fb02c57bb552cbf435c7c77343cf0a04b90a6c3b839255b0a9b199ddc77a5e674c53723d4b7bfca4795b0617524bf819851

data/README.md

@@ -0,0 +1,72 @@
+# Yet anoter Settings Plugin for Rails
+
+[![Gem Version](https://badge.fury.io/rb/groupped_settings.svg)](https://rubygems.org/gems/groupped_settings)
+[![Gem](https://img.shields.io/gem/dt/groupped_settings.svg)](https://rubygems.org/gems/groupped_settings/versions)
+[![YARD](https://badgen.net/badge/YARD/doc/blue)](http://www.rubydoc.info/gems/groupped_settings)
+
+
+[![Coverage](https://lysander.x.rnds.pro/api/v1/badges/gs_quality.svg)](https://lysander.x.rnds.pro/api/v1/badges/gs_quality.html)
+[![Quality](https://lysander.x.rnds.pro/api/v1/badges/gs_quality.svg)](https://lysander.x.rnds.pro/api/v1/badges/gs_quality.html)
+[![Outdated](https://lysander.x.rnds.pro/api/v1/badges/gs_outdated.svg)](https://lysander.x.rnds.pro/api/v1/badges/gs_outdated.html)
+[![Vulnerabilities](https://lysander.x.rnds.pro/api/v1/badges/gs_vulnerable.svg)](https://lysander.x.rnds.pro/api/v1/badges/gs_vulnerable.html)
+
+
+Groupped::Settings is a plugin that manage groupped settings for Rails :) Settings stored in own database table as json(b) field. Splitted by groups and can have polymorphyc referece to other models.
+
+## Setup
+
+`rails g rake groupped_settings:install`
+`rails g rake groupped:settings:migration`
+
+Now update your database with:
+
+`rake db:migrate`
+
+## Usage
+
+Define settings group class.
+```ruby
+class GeneralSettings < Groupped::Settings::Group
+  self.group_name = 'general'
+
+  attribute :identifier, :string, default: 'application'
+  attribute :secret, :string
+
+  validates :identifier, presence: true
+  validates :secret, length: { minimum: 16 }
+end
+```
+
+Using global settings:
+```ruby
+s = GeneralSettings.load
+s.identifier = '123123123'
+s.save!
+
+s = Groupped::Settings[:general, GeneralSettings]
+s.secret = '12345678987654321'
+s.save!
+```
+
+
+Using settings fot some model:
+```ruby
+s = GeneralSettings.load(target: User.first)
+s.identifier = '123123123'
+s.save!
+
+s = Groupped::Settings[:general, User.first]
+s.secret = '12345678987654321'
+s.save!
+```
+
+Include Settingsable concern:
+
+```ruby
+class User
+  include Groupped::Settings::Settingsable
+end
+
+
+s = User.first.settings_group(:general, GeneralSettings)
+```

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rails/generators/base'
+
+module Groupped
+  module Settings
+    module Generators
+
+
+      MissingORMError = Class.new(Thor::Error)
+
+      class InstallGenerator < Rails::Generators::Base
+
+        puts File.expand_path('../../templates', __dir__)
+        source_root File.expand_path('../../templates', __dir__)
+
+        desc 'Creates a Groupped::Settings initializer and copy locale files to your application.'
+
+        def copy_initializer
+          template 'groupped_settings.rb', 'config/initializers/groupped_settings.rb'
+        end
+
+      end
+
+
+    end
+  end
+end
+

data/lib/generators/groupped/settings/migration_generator.rb

@@ -0,0 +1,30 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+module Groupped
+  module Settings
+    class MigrationGenerator < Rails::Generators::Base
+
+
+      include Rails::Generators::Migration
+
+      desc 'Generates migration for rails-settings'
+      source_root File.expand_path('../../templates', __dir__)
+
+      def create_migration_file
+        migration_template 'migration.rb', 'db/migrate/groupped_settings_migration.rb'
+      end
+
+      def self.next_migration_number(dirname)
+        if ActiveRecord::Base.timestamped_migrations
+          Time.now.utc.strftime('%Y%m%d%H%M%S')
+        else
+          format('%.3d', (current_migration_number(dirname) + 1))
+        end
+      end
+
+
+    end
+  end
+end
+

data/lib/generators/templates/groupped_settings.rb

@@ -0,0 +1,3 @@
+Groupped::Settings.configure do |config|
+end
+

data/lib/generators/templates/migration.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+MIGRATION_BASE_CLASS = if ActiveRecord::VERSION::MAJOR >= 5
+  ActiveRecord::Migration[5.0]
+else
+  ActiveRecord::Migration
+end
+
+class GrouppedSettingsMigration < MIGRATION_BASE_CLASS
+
+  def self.up
+    create_table :groupped_settings_records do |t|
+      t.string :group, index: true, null: true
+
+      if t.respond_to? :jsonb
+        t.jsonb :settings, null: false, default: {}
+      else
+        t.json :settings, null: false, default: {}
+      end
+
+      t.belongs_to :target, polymorphic: true, type: :string, index: true, null: true
+    end
+  end
+
+  def self.down
+    drop_table :groupped_settings_records
+  end
+
+end
+

data/lib/groupped.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'groupped/settings'
+

data/lib/groupped/settings.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'groupped/settings/version'
+require 'groupped/settings/configuration'
+require 'groupped/settings/group'
+require 'groupped/settings/settingsable'
+
+module Groupped
+  module Settings
+
+    class << self
+
+      attr_accessor :config
+
+    end
+
+    self.config ||= ::Groupped::Settings::Configuration.new
+
+    class << self
+
+      def [](group, klass = Group, target: nil)
+        klass.new(Record.first_or_create!(group: group.downcase, target: target))
+      end
+
+      def configure
+        self.config ||= ::Groupped::Settings::Configuration.new
+        yield(config)
+        require 'groupped/settings/record'
+      end
+
+    end
+
+  end
+end
+

data/lib/groupped/settings/configuration.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'logger'
+
+module Groupped
+  module Settings
+    class Configuration
+
+      attr_accessor :base, :logger
+
+      def initialize
+        @logger = Logger.new(STDOUT, level: Logger::INFO, progname: 'Groupped::Settings')
+        @base = ::ActiveRecord::Base
+      end
+
+    end
+  end
+end
+

data/lib/groupped/settings/group.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Groupped
+  module Settings
+    class Group
+
+      include ActiveModel::Model
+      include ActiveModel::Attributes
+      include ActiveModel::Dirty
+      extend ActiveModel::Translation
+      include ActiveModel::Serializers::JSON
+
+      class << self
+
+        attr_accessor :group_name
+
+      end
+
+      def self.attribute_names
+        attribute_types.keys
+      end
+
+      def self.sanitize(settings)
+        Record.sanitize(settings).slice(*self.attribute_names)
+      end
+
+      def self.load(target: nil)
+        Groupped::Settings[self.group_name, self, target: target]
+      end
+
+      def initialize(record)
+        @settings_record = record
+        super(self.class.sanitize(record.settings))
+        clear_changes_information
+      end
+
+      def to_h
+        serializable_hash
+      end
+
+      def to_hash
+        serializable_hash
+      end
+
+      def group_name
+        self.class.group_name
+      end
+
+      def ==(other)
+        group_name == other.group_name && attributes == other.attributes
+      end
+
+      def save
+        save!
+      rescue StandardError => e
+        false
+      end
+
+      def save!
+        validate!
+        _save!
+        clear_changes_information
+        true
+      end
+
+      private
+
+        def _make_changes(changes)
+          changes.each_with_object({}) do |(key, (o, n)), ret|
+            ret[key.to_s.downcase] = n if o != n
+          end
+        end
+
+        def _save!
+          @settings_record.with_lock do
+            @settings_record.settings.merge!(_make_changes(changes))
+            @settings_record.save!
+          end
+        end
+
+    end
+  end
+end
+

data/lib/groupped/settings/record.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Groupped
+  module Settings
+    class Record < Groupped::Settings.config.base
+
+      self.table_name = 'groupped_settings_records'
+
+      belongs_to :target, polymorphic: true, required: false
+
+      def self.sanitize(settings)
+        settings.deep_transform_keys{|key| key.to_s.downcase }
+      end
+
+      before_validation do
+        self.settings = self.class.sanitize(self.settings)
+      end
+
+    end
+  end
+end
+

data/lib/groupped/settings/settingsable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Groupped
+  module Settings
+    module Settingsable
+
+      extend ActiveSupport::Concern
+
+      included do |_klass|
+        has_many :groupped_settings, as: :target, dependent: :destroy, class_name: Groupped::Settings::Record.to_s
+
+        def settings_group(group, klass = Group)
+          Groupped::Settings[group, klass, target: self]
+        end
+      end
+
+      class_methods do
+      end
+
+    end
+  end
+end
+

data/lib/groupped/settings/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Groupped
+  module Settings
+
+    VERSION = '0.1.2'
+
+  end
+end
+

data/lib/groupped_settings.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'groupped/settings'
+

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: groupped_settings
+version: !ruby/object:Gem::Version
+  version: 0.1.2.18705
+platform: ruby
+authors:
+- Samoilenko Yuri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !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: 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
+  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_junit_formatter
+  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: simplecov-console
+  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'
+description: Groupped::Settings is a plugin that manage groupped settings for Rails
+  :)
+email:
+- kinnalru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/generators/groupped/settings/install_generator.rb
+- lib/generators/groupped/settings/migration_generator.rb
+- lib/generators/templates/groupped_settings.rb
+- lib/generators/templates/migration.rb
+- lib/groupped.rb
+- lib/groupped/settings.rb
+- lib/groupped/settings/configuration.rb
+- lib/groupped/settings/group.rb
+- lib/groupped/settings/record.rb
+- lib/groupped/settings/settingsable.rb
+- lib/groupped/settings/version.rb
+- lib/groupped_settings.rb
+homepage: https://github.com/RnD-Soft/GrouppedSettings
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Groupped::Settings is a plugin that manage groupped settings for Rails :)
+test_files: []