setsy 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 210367dcac6e27b4fb49e9a491107c4ad88fd737
+  data.tar.gz: e71804965a62e65dd52f0f49accf28ed61de66f9
+SHA512:
+  metadata.gz: 343d21de9e910dcd54187542504e813bda10814a17c9c69c248f463f2a5cd3862e43f6e23f12d1b5e0adea46ac65f1d7a35a3529eed2bf67399fa91aefc23490
+  data.tar.gz: 15cf4707ef8fccdb99fc6b247c053fff760d813022daff1cd8e79b0f4563baf4b82029cd6f657c6f52fa07681e90e477587288abb362aec30e8169f222961cdc

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem
+.DS_Store
+.rspec_status

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in setsy.gemspec
+gemspec

data/README.md

@@ -0,0 +1,72 @@
+# Setsy
+
+Settings for your classes. Depends on ActiveRecord, ActiveModel, and ActiveSupport 5.1 (okay so Rails 5.1+), but a PR can take care of this easily!
+
+## Note
+
+This is not very tidy as it is. But it's battle-tested.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'setsy'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install setsy
+
+## Usage
+
+First, create a migration for a JSONB column. Call it `settings_data`, or something. Just don't call it `settings` if you want to be able to call `settings` on an instance. Default of `{}`
+
+In `app/models/user.rb`:
+
+```ruby
+class User < ApplicationRecord
+  
+  include ::Setsy::DSL
+  
+  # each setting can be a hash, like posts_limit, or just
+  DEFAULT_SETTINGS = {
+    posts_limit: { value: 10 },
+    favorite_color: 'blue'
+  }.freeze
+
+  # do some stuff.
+  # setsy <attribute_name>, <options>, <block of readers>
+  setsy :settings, column: :settings_data, defaults: DEFAULT_SETTINGS do |conf|
+    conf.reader :posts_limit_and_color do
+      "posts limit is #{posts_limit} and color is #{favorite_color}"
+    end
+  end
+end
+```
+
+These attributes will become available on `User#settings`, and will be backed by the `settings_data` column which you created as a JSONB column.
+
+Then in your controller or view or something,
+
+```erb 
+<% @user = User.first %>
+<% if @user.settings.posts_limit.default? %>
+Posts limit is default. 
+<% else %>
+Posts limit is <%= @user.settings.posts_limit %> 
+<% end %>
+<%= @user.settings.posts_limit_and_color %> 
+```
+
+## Testing
+
+See `spec`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joshmn/setsy.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler/gem_tasks'
+task default: :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "setsy"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/setsy.rb

@@ -0,0 +1,7 @@
+require 'setsy/attribute'
+require 'setsy/configuration'
+require 'setsy/dsl'
+require 'setsy/version'
+
+module Setsy
+end

data/lib/setsy/attribute.rb

@@ -0,0 +1,49 @@
+module Setsy
+  class Attribute
+    KLASS_MAP = {
+        'true' => 'Boolean',
+        'false' => 'Boolean',
+        'trueclass' => 'Boolean',
+        'falseclass' => 'Boolean',
+        'fixnum' => 'Integer'
+    }.freeze
+
+    delegate_missing_to :to_s
+    def initialize(options)
+      @attribute_value = options[:value]
+      @default = options[:default]
+      @options = options
+    end
+
+    def to_s
+      @to_s ||= cast(@attribute_value).to_s
+    end
+
+    def value
+      @value ||= cast(@attribute_value)
+    end
+    alias as_json value
+
+    def default
+      @default ||= cast(@default)
+    end
+
+    def default?
+      value == default
+    end
+
+    private
+
+    def klass
+      @klass ||= begin
+        klass = @default.class.to_s
+        klass = KLASS_MAP[klass.to_s.downcase] || klass
+        klass.downcase.to_sym
+      end
+    end
+
+    def cast(val)
+      ActiveModel::Type.lookup(klass).cast(val)
+    end
+  end
+end

data/lib/setsy/configuration.rb

@@ -0,0 +1,74 @@
+module Setsy
+  class Configuration
+    extend ActiveModel::Naming
+    include ActiveModel::Model
+    include ActiveModel::Serializers::JSON
+    SETTING_PREFIX = 'setting__'.freeze
+
+    def self.readers
+      @readers ||= {}
+    end
+
+    def self.reader(name, &block)
+      readers[name] = block
+      readers
+    end
+
+    def self.from_set(record, set, readers = {})
+      settings = {}
+      set = set.dup.with_indifferent_access
+      record.class.setsy_default.each do |k, v|
+        result = {}
+        result[:value] = v.is_a?(Hash) ? v[:value] : v
+        result[:default] = result[:value]
+        result[:value] = set[k] if set[k]
+        settings[k] = Attribute.new(result)
+      end
+      new(record, settings, readers)
+    end
+
+    def initialize(record, settings, readers = {})
+      @record = record
+      @settings = settings
+      write_readers(readers)
+    end
+
+    def method_missing(m, *args, &block)
+      if @settings.key?(m)
+        @settings[m]
+      elsif respond_to?("#{SETTING_PREFIX}#{m}")
+        send("#{SETTING_PREFIX}#{m}")
+      else
+        super
+      end
+    end
+
+    def respond_to_missing?(m, include_private = false)
+      @settings.key?(m) || "#{SETTING_PREFIX}#{m}" || super
+    end
+
+    def attributes
+      keys = @settings.keys
+      keys.push(*methods.select { |m| m.to_s.starts_with?(SETTING_PREFIX) }.map { |m| m.to_s.gsub(SETTING_PREFIX, '') })
+      h = {}
+      keys.each do |k|
+        h[k.to_sym] = k
+      end
+      h
+    end
+
+    private
+
+    def write_readers(readers)
+      readers.each { |k,v| write_reader(k, v) }
+    end
+
+    def write_reader(k, v)
+      class_eval do
+        define_method("#{SETTING_PREFIX}#{k}") do
+          instance_eval &v
+        end
+      end
+    end
+  end
+end

data/lib/setsy/dsl.rb

@@ -0,0 +1,37 @@
+module Setsy
+  module DSL
+    def self.included(base)
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def setsy(attribute_name, options = {})
+        readers = {}
+        readers = yield(Setsy::Configuration) if block_given?
+        class_eval do
+          define_method(:setsy_configuration) do
+            options[:defaults] || {}
+          end
+          define_singleton_method(:setsy_default) do
+            options[:defaults] || {}
+          end
+        end
+        instance_eval do
+          define_method(:setsy_configuration) do
+            if send(options[:column]).try(:empty?)
+              self.class.setsy_default
+            else
+              send(options[:column])
+            end
+          end
+          define_method(:setsy_default) do
+            self.class.setsy_default
+          end
+          define_method(attribute_name) do
+            Setsy::Configuration.from_set(self, setsy_configuration, readers)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/setsy/version.rb

@@ -0,0 +1,3 @@
+module Setsy
+  VERSION = "0.1.0"
+end

data/setsy.gemspec

@@ -0,0 +1,31 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'setsy/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'setsy'
+  spec.version       = Setsy::VERSION
+  spec.authors       = ['Josh Brody']
+  spec.email         = ['josh@josh.mn']
+  spec.licenses      = ['MIT']
+
+  spec.required_ruby_version = '>= 2.2'
+  spec.summary       = 'Settings for your classes'
+  spec.description   = 'Settings for your classes'
+  spec.homepage      = 'https://github.com/joshmn/setsy'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.files += Dir['lib/**/*.rb']
+
+  spec.add_dependency 'rails', '>= 5.1.0'
+  spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'pry', '~> 0.11.3'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

metadata

@@ -0,0 +1,140 @@
+--- !ruby/object:Gem::Specification
+name: setsy
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Josh Brody
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.1.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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.11.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Settings for your classes
+email:
+- josh@josh.mn
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/setsy.rb
+- lib/setsy/attribute.rb
+- lib/setsy/configuration.rb
+- lib/setsy/dsl.rb
+- lib/setsy/version.rb
+- setsy.gemspec
+homepage: https://github.com/joshmn/setsy
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Settings for your classes
+test_files: []