fusu 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5b0df9b35cbcd397ff4eaa1702330e0e0255f84a
-  data.tar.gz: 40b28b9e12efa5cf79f00171311c62e3616e0a37
+SHA256:
+  metadata.gz: abe9860bb714eb06dff8a1df416ee4002883d1f74a66166eb9ca61331f10cf35
+  data.tar.gz: 0472026d1cc75b37592ad0d61618c4e7dc3c1bc2711a8a73c1761fa3f95ac213
 SHA512:
-  metadata.gz: 028aaafaf603c46939c503d0f4b422fc4649503968d620b950e647f1b0ae4f33dce8d0dd5b7839e58d48bbc5cc6df1e79038c6b9d8478619a5ad5b4b81e34ad1
-  data.tar.gz: 28e4994d51bcdb01fd825e0382f5e4c312006a649872443a5ccb31f8ba3a5ff2bf222d86d0e53f40bf846926a644d1b35cb2558cd8f074a24c6d3eb809cec4b2
+  metadata.gz: 4a6b3ff3d19907727179ec8fe2646b3e88eb1047f4e90423bad354766e07c464e4b909807f9d75b05c9ad1359e1af4f5ee1e62359ea2a5ed35560f9f8122e9e5
+  data.tar.gz: db21445a5c0d8d4aa3f351f9ba42bcde5d293fd9a37bddac66f350ace8678fac0ab0bd54de3e3763fc07e296e0ba77beebd898887db6037c6facaa55b9f076eb

data/lib/fusu.rb

@@ -10,3 +10,5 @@ require "fusu/hash"
 require "fusu/string"
 require "fusu/regexp"
 require "fusu/hash_with_indifferent_access"
+require "fusu/configurable"
+require "fusu/concern"

data/lib/fusu/array.rb

@@ -9,5 +9,22 @@ module Fusu
         [object]
       end
     end
+
+    # Extracts options from a set of arguments. Removes and returns the last
+    # element in the array if it's a hash, otherwise returns a blank hash.
+    #
+    #   def options(*args)
+    #     args.extract_options!
+    #   end
+    #
+    #   options(1, 2)        # => {}
+    #   options(1, 2, a: :b) # => {:a=>:b}
+    def self.extract_options!(ary)
+      if ary.last.is_a?(::Hash) && Fusu::Hash.extractable_options?(ary.last)
+        ary.pop
+      else
+        {}
+      end
+    end
   end
 end

data/lib/fusu/blank.rb

@@ -11,5 +11,9 @@ module Fusu
         false
       end
     end
+
+    def presence(elem)
+      blank?(elem) ? nil : elem
+    end
   end
 end

data/lib/fusu/configurable.rb

@@ -0,0 +1,146 @@
+require "fusu/concern"
+require "fusu/ordered_options"
+
+module Fusu
+  # Configurable provides a <tt>config</tt> method to store and retrieve
+  # configuration options as an <tt>OrderedHash</tt>.
+  module Configurable
+    extend Fusu::Concern
+
+    class Configuration < Fusu::InheritableOptions
+      def compile_methods!
+        self.class.compile_methods!(keys)
+      end
+
+      # Compiles reader methods so we don't have to go through method_missing.
+      def self.compile_methods!(keys)
+        keys.reject { |m| method_defined?(m) }.each do |key|
+          class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            def #{key}; _get(#{key.inspect}); end
+          RUBY
+        end
+      end
+    end
+
+    module ClassMethods
+      def config
+        @_config ||= if respond_to?(:superclass) && superclass.respond_to?(:config)
+          superclass.config.inheritable_copy
+        else
+          # create a new "anonymous" class that will host the compiled reader methods
+          Class.new(Configuration).new
+        end
+      end
+
+      def configure
+        yield config
+      end
+
+      # Allows you to add shortcut so that you don't have to refer to attribute
+      # through config. Also look at the example for config to contrast.
+      #
+      # Defines both class and instance config accessors.
+      #
+      #   class User
+      #     include Fusu::Configurable
+      #     config_accessor :allowed_access
+      #   end
+      #
+      #   User.allowed_access # => nil
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   user = User.new
+      #   user.allowed_access # => false
+      #   user.allowed_access = true
+      #   user.allowed_access # => true
+      #
+      #   User.allowed_access # => false
+      #
+      # The attribute name must be a valid method name in Ruby.
+      #
+      #   class User
+      #     include Fusu::Configurable
+      #     config_accessor :"1_Badname"
+      #   end
+      #   # => NameError: invalid config attribute name
+      #
+      # To opt out of the instance writer method, pass <tt>instance_writer: false</tt>.
+      # To opt out of the instance reader method, pass <tt>instance_reader: false</tt>.
+      #
+      #   class User
+      #     include Fusu::Configurable
+      #     config_accessor :allowed_access, instance_reader: false, instance_writer: false
+      #   end
+      #
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   User.new.allowed_access = true # => NoMethodError
+      #   User.new.allowed_access        # => NoMethodError
+      #
+      # Or pass <tt>instance_accessor: false</tt>, to opt out both instance methods.
+      #
+      #   class User
+      #     include Fusu::Configurable
+      #     config_accessor :allowed_access, instance_accessor: false
+      #   end
+      #
+      #   User.allowed_access = false
+      #   User.allowed_access # => false
+      #
+      #   User.new.allowed_access = true # => NoMethodError
+      #   User.new.allowed_access        # => NoMethodError
+      #
+      # Also you can pass a block to set up the attribute with a default value.
+      #
+      #   class User
+      #     include Fusu::Configurable
+      #     config_accessor :hair_colors do
+      #       [:brown, :black, :blonde, :red]
+      #     end
+      #   end
+      #
+      #   User.hair_colors # => [:brown, :black, :blonde, :red]
+      def config_accessor(*names)
+        options = Fusu::Array.extract_options!(names)
+
+        names.each do |name|
+          raise NameError.new("invalid config attribute name") unless /\A[_A-Za-z]\w*\z/.match?(name)
+
+          reader, reader_line = "def #{name}; config.#{name}; end", __LINE__
+          writer, writer_line = "def #{name}=(value); config.#{name} = value; end", __LINE__
+
+          singleton_class.class_eval reader, __FILE__, reader_line
+          singleton_class.class_eval writer, __FILE__, writer_line
+
+          unless options[:instance_accessor] == false
+            class_eval reader, __FILE__, reader_line unless options[:instance_reader] == false
+            class_eval writer, __FILE__, writer_line unless options[:instance_writer] == false
+          end
+          send("#{name}=", yield) if block_given?
+        end
+      end
+      private :config_accessor
+    end
+
+    # Reads and writes attributes from a configuration <tt>OrderedHash</tt>.
+    #
+    #   require 'fusu/configurable'
+    #
+    #   class User
+    #     include Fusu::Configurable
+    #   end
+    #
+    #   user = User.new
+    #
+    #   user.config.allowed_access = true
+    #   user.config.level = 1
+    #
+    #   user.config.allowed_access # => true
+    #   user.config.level          # => 1
+    def config
+      @_config ||= self.class.config.inheritable_copy
+    end
+  end
+end

data/lib/fusu/hash.rb

@@ -8,5 +8,13 @@ module Fusu
     extend Keys
     extend ReverseMerge
     extend DeepMerge
+
+    def extractable_options?(elem)
+      elem.instance_of?(::Hash)
+    end
+
+    def reject_key(hash, *keys)
+      hash.reject{ |k, v| keys.include?(k) }
+    end
   end
 end

data/lib/fusu/ordered_options.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+module Fusu
+  # Usually key value pairs are handled something like this:
+  #
+  #   h = {}
+  #   h[:boy] = 'John'
+  #   h[:girl] = 'Mary'
+  #   h[:boy]  # => 'John'
+  #   h[:girl] # => 'Mary'
+  #   h[:dog]  # => nil
+  #
+  # Using +OrderedOptions+, the above code could be reduced to:
+  #
+  #   h = ActiveSupport::OrderedOptions.new
+  #   h.boy = 'John'
+  #   h.girl = 'Mary'
+  #   h.boy  # => 'John'
+  #   h.girl # => 'Mary'
+  #   h.dog  # => nil
+  #
+  # To raise an exception when the value is blank, append a
+  # bang to the key name, like:
+  #
+  #   h.dog! # => raises KeyError: :dog is blank
+  #
+  class OrderedOptions < ::Hash
+    alias_method :_get, :[] # preserve the original #[] method
+    protected :_get # make it protected
+
+    def []=(key, value)
+      super(key.to_sym, value)
+    end
+
+    def [](key)
+      super(key.to_sym)
+    end
+
+    def method_missing(name, *args)
+      name_string = name.to_s
+      if name_string.chomp!("=")
+        self[name_string] = args.first
+      else
+        bangs = name_string.chomp!("!")
+
+        if bangs
+          Fusu.presence(self[name_string]) || raise(KeyError.new(":#{name_string} is blank"))
+        else
+          self[name_string]
+        end
+      end
+    end
+
+    def respond_to_missing?(name, include_private)
+      true
+    end
+  end
+
+  # +InheritableOptions+ provides a constructor to build an +OrderedOptions+
+  # hash inherited from another hash.
+  #
+  # Use this if you already have some hash and you want to create a new one based on it.
+  #
+  #   h = ActiveSupport::InheritableOptions.new({ girl: 'Mary', boy: 'John' })
+  #   h.girl # => 'Mary'
+  #   h.boy  # => 'John'
+  class InheritableOptions < OrderedOptions
+    def initialize(parent = nil)
+      if parent.kind_of?(OrderedOptions)
+        # use the faster _get when dealing with OrderedOptions
+        super() { |h, k| parent._get(k) }
+      elsif parent
+        super() { |h, k| parent[k] }
+      else
+        super()
+      end
+    end
+
+    def inheritable_copy
+      self.class.new(self)
+    end
+  end
+end

data/lib/fusu/version.rb

@@ -1,3 +1,3 @@
 module Fusu
-  VERSION = "0.2.0"
+  VERSION = "0.2.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fusu
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Artur Panyach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-11-02 00:00:00.000000000 Z
+date: 2018-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,12 +74,14 @@ files:
 - lib/fusu/array.rb
 - lib/fusu/blank.rb
 - lib/fusu/concern.rb
+- lib/fusu/configurable.rb
 - lib/fusu/hash.rb
 - lib/fusu/hash/deep_merge.rb
 - lib/fusu/hash/except.rb
 - lib/fusu/hash/keys.rb
 - lib/fusu/hash/reverse_merge.rb
 - lib/fusu/hash_with_indifferent_access.rb
+- lib/fusu/ordered_options.rb
 - lib/fusu/regexp.rb
 - lib/fusu/string.rb
 - lib/fusu/string/methods.rb
@@ -105,7 +107,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.3
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Functional support