usable 3.7.1 → 3.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0a5a38c4e6b7ce12dc8babbb63d9c8ebfca63619
-  data.tar.gz: 3657c1890f435d920a0e08429956f728fec8b330
+SHA256:
+  metadata.gz: bcc17af85e47b938b6f6f86196d7a1a244e062ac1e7c77c4b6260138c18d9bdb
+  data.tar.gz: d800dcd7e7d2cff57ba7f2d96e5168a388b503ae480b83980d67286b55d7d970
 SHA512:
-  metadata.gz: 9581e053956c78d748cb59431395d569d059b52f5682834a2834ac53d136ca1b55561852bebf6626e1bcddc6dfd697c8890209df11d17a5040e4a6766cf8c9ec
-  data.tar.gz: b8b305ed5e491828febd8f68b0767bbed70425636b5196609700578a04c275103d7945ea0630730d04eb8d5b3cec97ae6a58adcdf705ae47f9868f53248ff6cd
+  metadata.gz: 2c03ec68bf89ff9e4b9ac0d72e2a5a72b7977375169957ae4873462a3e77c68aa01bb91afd7d18415113c5f50c58e00648292ca6932c81849ddea5dab90858a0
+  data.tar.gz: e631aece8d224022d1d07c4e777d978111e987bb5a803ed9ea4309701ee553adf11ca516e77f02312a2523a53510ae7dfd699a84590de3027d9c3df470d3c404

data/lib/usable.rb

@@ -88,6 +88,15 @@ module Usable
     super
   end
 
+  def define_usable_accessors
+    usables.to_h.keys.each do |key|
+      define_singleton_method(key) { usables.send(key) }
+      define_singleton_method("#{key}=") { |new_val| usables.send("#{key}=", new_val) }
+      define_method(key) { usables.send(key) }
+      define_method("#{key}=") { |new_val| usables.send("#{key}=", new_val) }
+    end
+  end
+
   def usables
     @usables ||= Config.new
   end
@@ -113,11 +122,14 @@ module Usable
   # @return self
   def usable(*args, &block)
     options = args.last.is_a?(Hash) ? args.pop : {}
+    only = options.delete(:only)
+    extension_method = options.delete(:method)
     args.each do |mod|
-      ModExtender.new(mod, only: options.delete(:only), method: options.delete(:method)).call self
+      ModExtender.new(mod, only: only, method: extension_method).call self
       # Define settings on @usables and on the scoped @usables
       scope = Config.new
-      if mod.name
+      # Nest the new config under a namespace based on it's name, unless it's the default name we gave
+      if mod.name && !mod.name.include?("UsableMod")
         scope_name = mod.name.split('::').last.gsub(/\B([A-Z])([a-z_0-9])/, '_\1\2').downcase
         usables[scope_name] = scope
       end

data/lib/usable/config.rb

@@ -30,8 +30,12 @@ module Usable
       @spec.to_h.each(&block)
     end
 
+    # @note The @spec[key] could already be set in cases where the config was merged with another
+    #   For example, a usable module defines a default with a block, and when mounting the module
+    #   the same usable option is overridden as an options hash (usable mod, key: 'val')
     def to_h
-      @lazy_loads.each { |key| @spec[key] = call_spec_method(key) }
+      @lazy_loads.each { |key| @spec[key] ||= @spec.public_send(key) }
+      @lazy_loads.clear
       @spec.to_h
     end
 
@@ -43,10 +47,22 @@ module Usable
       to_h.merge(other)
     end
 
+    # @param other [Hash] to update ourselves with
+    def merge!(other)
+      other.each do |key, val|
+        @spec[key] = val
+      end
+      self
+    end
+
+    def include?(key)
+      !!@spec[key] || @lazy_loads.include?(key.to_sym)
+    end
+
     def method_missing(key, *args, &block)
       if block
         @lazy_loads << key
-        @spec.define_singleton_method(key) { yield }
+        @spec.define_singleton_method(key, &block)
       else
         # Needs to be a symbol so we can consistently access @lazy_loads
         key = key.to_s.tr('=', '').to_sym
@@ -55,10 +71,10 @@ module Usable
             # Cleanup, just in case we loaded it another way (e.g. combining with another usable config)
             @lazy_loads.delete key
           else
-            @spec[key] = call_spec_method(key)
+            @spec[key] = call_spec_method(key) unless frozen?
           end
           # Define method so we don't hit method missing again
-          define_singleton_method(key) { @spec[key] }
+          define_singleton_method(key) { @spec[key] } unless frozen?
           @spec[key]
         else
           @spec[key] = args.first

data/lib/usable/mod_extender.rb

@@ -18,9 +18,7 @@ module Usable
     # @description Directly include a module whose methods you want made available in +usables.available_methods+
     #   Gives the module a name when including so that it shows up properly in the list of ancestors
     def call(target)
-      unwanted.each do |method_name|
-        copy.send :remove_method, method_name
-      end
+      unwanted.each(&method(:remove_from_module))
       if copy.name.nil?
         const_name = "#{mod_name}Used"
         target.send :remove_const, const_name if target.const_defined? const_name, false
@@ -46,5 +44,16 @@ module Usable
         @copy.instance_methods - Array(only)
       end
     end
+
+    def remove_from_module(method_name)
+      begin
+        copy.send :remove_method, method_name
+      rescue NameError => e
+        # Expected sometimes, like it could be raised trying to remove a superclass method
+        Usable.logger.debug("#{e.class}: #{e.message}")
+      end
+      # Block access to superclass method, and prevent it from being copied to the target
+      copy.send :undef_method, method_name if copy.instance_methods.include?(method_name)
+    end
   end
 end

data/lib/usable/persistence.rb

@@ -0,0 +1,82 @@
+require 'fileutils'
+require 'yaml'
+
+module Usable
+  module Persistence
+    # = Stores usables in a yaml file
+
+    extend Usable
+
+    config do
+      dir { defined?(Rails) ? Rails.root.join('tmp') : File.expand_path('..', __FILE__) }
+    end
+
+    def self.extended(base)
+      base.extend Usable
+      base.usable self
+    end
+
+    # Automatically copied over by +usable+
+    module InstanceMethods
+      # Accessor to read and write default ActiveRecord objects
+      # When assigning a config, a reference to it is saved to tmp/<mod_name>.yml
+      # and loaded in subsequent console sessions
+      def method_missing(name, *args, &block)
+        if block
+          usables.public_send(name, &block)
+        elsif name.to_s.end_with?('=') && args.length == 1
+          _save name.to_s.tr('=', '').to_sym, args.pop
+        elsif usables[name]
+          usables[name]
+        elsif _config[name]
+          usables[name] = if _config[name].is_a?(Hash)
+                            _config[name].fetch(:class).constantize.find(_config[name].fetch(:id))
+                          else
+                            _config[name]
+                          end
+        else
+          usables.public_send(name) || super
+        end
+      end
+
+      def has?(setting)
+        !!send(setting)
+      rescue NoMethodError => e
+        if e.message.include?("method `#{setting}'")
+          false
+        else
+          raise
+        end
+      end
+
+      #
+      # Private
+      #
+
+      def _save(key, val = nil)
+        if val.nil?
+          _config.delete(key)
+        elsif val.respond_to?(:persisted?) && val.persisted?
+          _config[key] = { class: val.class.name, id: val.id }
+        else
+          _config[key] = val
+        end
+        File.open(_config_file, 'wb') { |f| f.puts _config.to_yaml }
+        usables[key] = val
+      end
+
+      def _config_file
+        return @_config_file if @_config_file
+        FileUtils.mkdir_p(usables.dir) unless File.directory?(usables.dir)
+        filename = self.class.name ? self.class.name.downcase.gsub('::', '_') : 'usable'
+        @_config_file = File.join(usables.dir, "#{filename}.yml")
+        FileUtils.touch(@_config_file) unless File.exists?(@_config_file)
+        @_config_file
+      end
+
+      def _config
+        @_config ||= YAML.load_file(_config_file) || {}
+      end
+    end
+  end
+end

data/lib/usable/struct.rb

@@ -2,10 +2,9 @@ module Usable
   def self.Struct(attributes = {})
     Class.new do
       extend Usable
-
       self.usables = Usable::Config.new(attributes)
-
-      attributes.keys.each do |key|
+      define_usable_accessors
+      attributes.keys.map(&:to_sym).each do |key|
         define_method(key) { @attrs[key] }
         define_method("#{key}=") { |new_val| @attrs[key] = new_val }
       end
@@ -15,6 +14,30 @@ module Usable
       def initialize(attrs = {})
         @attrs = usables.merge(attrs)
       end
+
+      def [](key)
+        @attrs[key]
+      end
+
+      def []=(key, val)
+        @attrs[key] = val
+      end
+
+      def each(&block)
+        @attrs.each(&block)
+      end
+
+      def to_h
+        @attrs.dup
+      end
+
+      alias to_hash to_h
+
+      def merge(other)
+        to_h.merge!(other)
+      end
+
+      alias + merge
     end
   end
 end

data/lib/usable/version.rb

@@ -1,3 +1,3 @@
 module Usable
-  VERSION = "3.7.1".freeze
+  VERSION = "3.9.3".freeze
 end

data/usable.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.0.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.10'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '>= 3.2', '< 4'
+  spec.add_development_dependency "bundler", "~> 2.2.11"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", ">= 3.2", "< 4"
   # spec.add_development_dependency 'rspec-scaffold', '>= 1.0', '< 2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: usable
 version: !ruby/object:Gem::Version
-  version: 3.7.1
+  version: 3.9.3
 platform: ruby
 authors:
 - Ryan Buckley
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-04-03 00:00:00.000000000 Z
+date: 2021-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.11
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.10'
+        version: 2.2.11
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -71,6 +71,7 @@ files:
 - lib/usable/config_register.rb
 - lib/usable/eager_load.rb
 - lib/usable/mod_extender.rb
+- lib/usable/persistence.rb
 - lib/usable/railtie.rb
 - lib/usable/struct.rb
 - lib/usable/version.rb
@@ -79,7 +80,7 @@ homepage: https://github.com/ridiculous/usable
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -94,9 +95,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
-signing_key: 
+rubygems_version: 3.2.11
+signing_key:
 specification_version: 4
 summary: Mounts and configures modules
 test_files: []