skn_utils 3.3.11 → 3.3.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2320444637a8553023d0ec9e5f911b98088fd4d3
-  data.tar.gz: 826ebe50285744c864944b884a242be41ae71f73
+  metadata.gz: e6048e54b3ef049c2f0cc12d2e5d8c1068464bf9
+  data.tar.gz: 13d07f94bf6785297b7da9f407447abe7ea0242c
 SHA512:
-  metadata.gz: 6cd9147939ac1b4faa2b06cf588013628dfa56ec5f9b2b5bc8e003f5a90c4425ce45e74d1b4d291e4650d84bd386ddd7ea0b07b7d265191d1c8bd25951b5a095
-  data.tar.gz: e9e72e2a88758598cf6ba9fee28b94f7fb3c9f47bb176baf5b648d68038ae98bdbad2591fd030577805d06e7d11b529b8c056ef3089c2cd60a1721873a5ed51b
+  metadata.gz: 491f607e8959573f8d9a8806d1447802507fb50a8ae51487fa428421a87c3b20569fe62212f0cc6a1b6226182dba2f25a6813515fe78fa60bced473fcb8be1fe
+  data.tar.gz: 8237f57472729b24e8b25b7346bdda8413f0d0616f1942dbda9d6cda1f05a558c91441ba68d0f40fcbc48a65bb8b8b7678a23790ebef05cfd1a861dbb055da5e

data/README.md

@@ -54,7 +54,8 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
 
 ## Public Components
     SknUtils::NestedResult           # >= V 3.0.0 Primary Key/Value Container with Dot/Hash notiation support.
-    SknSettings                      # Application Configuration class, Key/Value Container with Dot/Hash notiation support.
+    SknSettings                      # Multi-level application Configuration class, Key/Value Container with Dot/Hash notiation support.
+    SknUtils::Configurable           # Basic one-level configuration settings module for Applications and or Gems
 
     SknHash                          # Wrapper for name only, WITHOUT SknUtils namespace, inherits from SknUtils::NestedResult
     SknUtils::ResultBean             # Wrapper for name only, inherits from SknUtils::NestedResult
@@ -65,6 +66,7 @@ Ruby Gem containing a Ruby PORO (Plain Old Ruby Object) that can be instantiated
     SknUtils::List::CircularLinkedList  # List with forward (#next) and backward (#prev) navigation, and head/tail wrapping
 
 
+
 ## Configuration Options
     None required other than initialization hash
 

data/bin/console

@@ -2,6 +2,10 @@
 
 require 'bundler/setup'
 require 'skn_utils'
+require 'skn_utils/business_services/year_month'
+require 'skn_utils/exploring/commander'
+require 'skn_utils/exploring/action_service'
+require 'skn_utils/exploring/configuration'
 
 require 'pry'
 Pry.start

data/lib/skn_utils/business_services/year_month.rb

@@ -0,0 +1,58 @@
+##
+# File: <gem-root>/lib/skn_utils/business_services/year_month.rb
+#  Ref: http://blog.arkency.com/2014/08/using-ruby-range-with-custom-classes/
+#
+## Calculates YearMonth
+#
+# YearMonth.new(2014, 3) > YearMonth.new(2014, 1)
+# => true
+
+# YearMonth.new(2014, 1) >= YearMonth.new(2014, 1)
+# => true
+
+# YearMonth.new(2015, 1) < YearMonth.new(2014, 3)
+# => false
+#
+module SknUtils
+  module BusinessServices
+
+    class YearMonth < Struct.new(:year, :month)
+      include Comparable
+
+      def initialize(iyear, imonth)
+        cleaned_year = iyear.to_i
+        cleaned_month = imonth.to_i
+
+        raise ArgumentError unless cleaned_year > 0
+        raise ArgumentError unless cleaned_month >= 1 && cleaned_month <= 12
+
+        super(cleaned_year, cleaned_month)
+      end
+
+      def next
+        if month == 12
+          self.class.new(year+1, 1)
+        else
+          self.class.new(year, month+1)
+        end
+      end
+      alias_method :succ, :next
+
+      def <=>(other)
+        (year <=> other.year).nonzero? || month <=> other.month
+      end
+
+      # need to do some time calcs
+
+      def beginning_of
+        Time.parse("12:00",Date.new(year, month, 1).to_time) # strftime('%Y-%m-%d')
+      end
+
+      def end_of
+        Time.parse("12:00",Date.new(year, month, -1).to_time) # strftime('%Y-%m-%d')
+      end
+
+      private :year=, :month=
+    end
+  end
+end

data/lib/skn_utils/configurable.rb

@@ -0,0 +1,79 @@
+##
+# File: <gem-root>/lib/skn_utils/configurable.rb
+#  Ref: https://www.toptal.com/ruby/ruby-dsl-metaprogramming-guide
+#
+
+module SknUtils
+
+# In the end, we have got ourselves a pretty neat module for making an arbitrary
+# class configurable and then specifying those configuration values using a clean
+# and simple DSL that also lets us reference one configuration attribute
+# from another:
+#
+#################
+# Inside Target component
+#################
+# class MyApp
+#   include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
+#   # ...
+# end
+#
+#################
+# Inside Initializer
+#################
+# MyApp.configure do
+#   app_id "my_app"
+#   title "My App"
+#   cookie_name { "#{app_id}_session" }
+# end
+#
+#################
+# Usage:
+#################
+# MyApp.config.app_id # ==> "my_app"
+#
+# Here is the final version of the module that implements our DSL—a total of 36 lines of code:
+
+  module Configurable
+
+    def self.with(*attrs)
+      not_provided = Object.new
+
+      # Define the class/module methods
+      config_class = Class.new do
+        attrs.each do |attr|
+          define_method attr do |value = not_provided, &block|
+            if value === not_provided && block.nil?
+              result = instance_variable_get("@#{attr}")
+              result.is_a?(Proc) ? instance_eval(&result) : result
+            else
+              instance_variable_set("@#{attr}", block || value)
+            end
+          end
+        end
+
+        attr_writer *attrs
+       end
+
+      # Define the runtime access methods
+      class_methods = Module.new do
+        define_method :config do
+          @config ||= config_class.new
+        end
+
+        def configure(&block)
+          config.instance_eval(&block)
+        end
+      end
+
+      # Apply the custom configuration
+      Module.new do
+        singleton_class.send :define_method, :included do |host_class|
+          host_class.extend class_methods
+        end
+      end
+
+    end # method
+
+  end # end module
+end # End module

data/lib/skn_utils/notifier_base.rb

@@ -3,7 +3,14 @@
 # Ruby Notify like class
 #
 # Ref: https://ozone.wordpress.com/category/programming/metaprogramming/
-
+##
+# Listeners implement:
+#
+#  def attribute_changed(attr, old, new)
+#    ...
+#  end
+#
+#
 module SknUtils
   class NotifierBase
 

data/lib/skn_utils/version.rb

@@ -3,7 +3,7 @@ module SknUtils
   class Version
     MAJOR = 3
     MINOR = 3
-    PATCH = 11
+    PATCH = 12
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/lib/skn_utils.rb

@@ -2,8 +2,10 @@ require "skn_utils/version"
 require 'psych'
 require 'json'
 require 'erb'
+require 'date'
+require 'time'
 unless defined?(Rails)
- require 'deep_merge'
+  require 'deep_merge'
 end
 require 'skn_utils/nested_result'
 require 'skn_utils/result_bean'
@@ -11,13 +13,15 @@ require 'skn_utils/page_controls'
 require 'skn_utils/null_object'
 require 'skn_utils/notifier_base'
 require 'skn_utils/skn_configuration'
+require 'skn_utils/configurable'
 require 'skn_utils/lists/linked_commons'
 require 'skn_utils/lists/link_node'
 require 'skn_utils/lists/linked_list'
 require 'skn_utils/lists/doubly_linked_list'
 require 'skn_utils/lists/circular_linked_list'
-require 'skn_utils/exploring/commander'
-require 'skn_utils/exploring/action_service'
+# require 'skn_utils/business_services/year_month'
+# require 'skn_utils/exploring/commander'
+# require 'skn_utils/exploring/action_service'
 # require 'skn_utils/exploring/configuration'
 require 'skn_hash'
 require 'skn_settings'

data/spec/lib/skn_utils/business_services/year_month_spec.rb

@@ -0,0 +1,49 @@
+##
+# spec/lib/skn_utils/node_based_linked_list_spec.rb
+#
+
+RSpec.describe SknUtils::BusinessServices::YearMonth, "Year Month Calculator " do
+
+  let(:basic) { described_class.new(2017, 1) }
+
+  context "Normal Operations " do
+
+    it "No params" do
+      expect{described_class.new}.to raise_error(ArgumentError)
+    end
+    it "With Params" do
+      expect(basic).to be_a described_class
+    end
+    it "#beginning_of month to be correct. " do
+      expect(basic.beginning_of).to be_a Time
+    end
+    it "#end_of month to be correct. " do
+      expect(basic.end_of).to be_a Time
+    end
+    it "#month to equal 3." do
+      expect(basic.month).to eq(1)
+    end
+    it "#year to equal 2017." do
+      expect(basic.year).to eq(2017)
+    end
+    it "#next.month to equal 2." do
+      expect(basic.next.month).to eq(2)
+    end
+    it "Comparisons are correct." do
+      expect(described_class.new(2017,1)).to eq(described_class.new(2017,1))
+      expect(described_class.new(2017,2)).to be > (described_class.new(2017,1))
+      expect(described_class.new(2017,1)).to be < (described_class.new(2017,2))
+    end
+  end
+
+  context "Range Operations " do
+
+    it "Can be represented in a Range object.  " do
+      range = described_class.new(2017, 1)..described_class.new(2017, 9)
+
+      expect(range).to  include(described_class.new(2017, 2))
+      expect(range).to  include(described_class.new(2017, 7))
+    end
+  end
+
+end

data/spec/lib/skn_utils/configurable_spec.rb

@@ -0,0 +1,57 @@
+##
+# spec/lib/skn_utils/exploring/configuration_spec.rb
+#
+
+class MyApp
+  include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
+
+  def null_value
+    @app_id.dup
+  end
+end
+
+module MyMod
+  include SknUtils::Configurable.with(:app_id, :title, :cookie_name)
+
+  def self.null_value
+    @@app_id.dup
+  end
+end
+
+MyApp.configure do
+       app_id 'some app'
+        title 'My Title'
+  cookie_name 'Chocolate'
+end
+
+MyMod.configure do
+       app_id 'some module'
+        title 'Some Title'
+  cookie_name 'Caramel'
+end
+
+
+describe SknUtils::Configurable, "Gem Configuration module." do
+
+  let(:my_app) { MyApp.new }
+
+
+  context "Operational Features. " do
+
+    it "my_app#config.title returns expected value. " do
+      expect( MyApp.config.title ).to eq( "My Title" )
+    end
+    it "my_app#config.app_id returns expected value. " do
+      expect( MyApp.config.app_id ).to eq( "some app" )
+    end
+
+    it "MyMod#config.app_id  returns expected value. " do
+      expect( MyMod.config.app_id ).to eq( "some module" )
+    end
+    it "MyMod#config.cookie_name returns expected value. " do
+      expect( MyMod.config.cookie_name ).to eq( 'Caramel' )
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -15,6 +15,7 @@ require 'skn_utils'
 require 'skn_utils/exploring/commander'
 require 'skn_utils/exploring/action_service'
 require 'skn_utils/exploring/configuration'
+require 'skn_utils/business_services/year_month'
 
 require 'rspec'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skn_utils
 version: !ruby/object:Gem::Version
-  version: 3.3.11
+  version: 3.3.12
 platform: ruby
 authors:
 - James Scott Jr
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-08-18 00:00:00.000000000 Z
+date: 2017-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -134,6 +134,8 @@ files:
 - lib/skn_hash.rb
 - lib/skn_settings.rb
 - lib/skn_utils.rb
+- lib/skn_utils/business_services/year_month.rb
+- lib/skn_utils/configurable.rb
 - lib/skn_utils/exploring/action_service.rb
 - lib/skn_utils/exploring/commander.rb
 - lib/skn_utils/exploring/configuration.rb
@@ -154,6 +156,8 @@ files:
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
+- spec/lib/skn_utils/business_services/year_month_spec.rb
+- spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb
@@ -200,6 +204,8 @@ test_files:
 - spec/factories/settings/test.local.yml
 - spec/factories/settings/test.yml
 - spec/lib/skn_settings_spec.rb
+- spec/lib/skn_utils/business_services/year_month_spec.rb
+- spec/lib/skn_utils/configurable_spec.rb
 - spec/lib/skn_utils/exploring/action_service_spec.rb
 - spec/lib/skn_utils/exploring/commander_spec.rb
 - spec/lib/skn_utils/exploring/configuration_spec.rb