accessory 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9880e7e5ea88c0b373a1cc3d5d4861788f368905c761b2ec3a7236d7282ada39
-  data.tar.gz: 7386d98dc728a663904564e0a6825de0d7690e806950e5e95d6e8b39d4d20cd6
+  metadata.gz: 9f4517af7f1ae501a9dea6721f8dd0966a85c2fd9e8ada3d1d444f8b58cb297e
+  data.tar.gz: 4e8bcc0130b9cb5078779642cc0e81f4d4121ac6275ead2fe7a5decd873a5047
 SHA512:
-  metadata.gz: dbee544b8dc699adb962559b98278d48edeed2a4d5b9c4d3c6c92ad3c4a38ffb4df5ced18274b465dfe68fd34dd15a50c06c2febae4e54049a4049d377cb10cd
-  data.tar.gz: 0d1be0f43650e87a1616b5c2ac968b7407c5d8e380abb7e30ad84823816d486341a2c1b791814c55695dc77f2bf0337df834816c2a703bacbb2a3f582f362907
+  metadata.gz: 295b43b1f100522c1dcc9e659acbcf174a9725c38448d68b8eb3be10603b9ad9df643f82dced994849616d194ccef080697febc3f934440b45420eae8229fa31
+  data.tar.gz: 5d9d93d0a17668ba39313dd8151cf7324a562df362fbbeb0a34bdc6c24b2dc7a8996f36f8e0b1be1c0d489dafc435f645e1b8a4348e3a080bdd66e9efe5dbc61

data/lib/accessory.rb

@@ -1,6 +1,3 @@
-##
-#
-
 module Accessory; end
 
 require 'accessory/version'

data/lib/accessory/access.rb

@@ -18,59 +18,59 @@ require 'accessory/accessors/last_accessor'
 #    include Accessory
 
 module Accessory::Access
-  # (see Accessory::SubscriptAccessor)
+  # (see Accessory::Accessors::SubscriptAccessor)
   def self.subscript(...)
-    Accessory::SubscriptAccessor.new(...)
+    Accessory::Accessors::SubscriptAccessor.new(...)
   end
 
-  # (see Accessory::AttributeAccessor)
+  # (see Accessory::Accessors::AttributeAccessor)
   def self.attr(...)
-    Accessory::AttributeAccessor.new(...)
+    Accessory::Accessors::AttributeAccessor.new(...)
   end
 
-  # (see Accessory::InstanceVariableAccessor)
+  # (see Accessory::Accessors::InstanceVariableAccessor)
   def self.ivar(...)
-    Accessory::InstanceVariableAccessor.new(...)
+    Accessory::Accessors::InstanceVariableAccessor.new(...)
   end
 
-  # (see Accessory::BetwixtAccessor)
+  # (see Accessory::Accessors::BetwixtAccessor)
   def self.betwixt(...)
-    Accessory::BetwixtAccessor.new(...)
+    Accessory::Accessors::BetwixtAccessor.new(...)
   end
 
-  # Alias for +Accessory::Access.betwixt(0)+. See {Access.betwixt}
+  # Alias for +Accessory::Accessors::Access.betwixt(0)+. See {Access.betwixt}
   def self.before_first
     self.betwixt(0)
   end
 
-  # Alias for +Accessory::Access.betwixt(-1)+. See {Access.betwixt}
+  # Alias for +Accessory::Accessors::Access.betwixt(-1)+. See {Access.betwixt}
   def self.after_last
     self.betwixt(-1)
   end
 
-  # (see Accessory::BetweenEachAccessor)
+  # (see Accessory::Accessors::BetweenEachAccessor)
   def self.between_each
-    Accessory::BetweenEachAccessor.new
+    Accessory::Accessors::BetweenEachAccessor.new
   end
 
-  # (see Accessory::AllAccessor)
+  # (see Accessory::Accessors::AllAccessor)
   def self.all
-    Accessory::AllAccessor.new
+    Accessory::Accessors::AllAccessor.new
   end
 
-  # (see Accessory::FirstAccessor)
+  # (see Accessory::Accessors::FirstAccessor)
   def self.first
-    Accessory::FirstAccessor.new
+    Accessory::Accessors::FirstAccessor.new
   end
 
-  # (see Accessory::LastAccessor)
+  # (see Accessory::Accessors::LastAccessor)
   def self.last
-    Accessory::LastAccessor.new
+    Accessory::Accessors::LastAccessor.new
   end
 
-  # (see Accessory::FilterAccessor)
+  # (see Accessory::Accessors::FilterAccessor)
   def self.filter(&pred)
-    Accessory::FilterAccessor.new(pred)
+    Accessory::Accessors::FilterAccessor.new(pred)
   end
 end
 
@@ -83,29 +83,29 @@ end
 # {Lens} or {BoundLens} from the addition of the accessor.
 
 module Accessory::Access::FluentHelpers
-  # (see Accessory::SubscriptAccessor)
+  # (see Accessory::Accessors::SubscriptAccessor)
   def subscript(...)
-    self.then(Accessory::SubscriptAccessor.new(...))
+    self.then(Accessory::Accessors::SubscriptAccessor.new(...))
   end
 
   # Alias for {#subscript}
   def [](...)
-    self.then(Accessory::SubscriptAccessor.new(...))
+    self.then(Accessory::Accessors::SubscriptAccessor.new(...))
   end
 
-  # (see Accessory::AttributeAccessor)
+  # (see Accessory::Accessors::AttributeAccessor)
   def attr(...)
-    self.then(Accessory::AttributeAccessor.new(...))
+    self.then(Accessory::Accessors::AttributeAccessor.new(...))
   end
 
-  # (see Accessory::InstanceVariableAccessor)
+  # (see Accessory::Accessors::InstanceVariableAccessor)
   def ivar(...)
-    self.then(Accessory::InstanceVariableAccessor.new(...))
+    self.then(Accessory::Accessors::InstanceVariableAccessor.new(...))
   end
 
-  # (see Accessory::BetwixtAccessor)
+  # (see Accessory::Accessors::BetwixtAccessor)
   def betwixt(...)
-    self.then(Accessory::BetwixtAccessor.new(...))
+    self.then(Accessory::Accessors::BetwixtAccessor.new(...))
   end
 
   # Alias for +#betwixt(0)+. See {#betwixt}
@@ -118,29 +118,29 @@ module Accessory::Access::FluentHelpers
     self.betwixt(-1)
   end
 
-  # (see Accessory::BetweenEachAccessor)
+  # (see Accessory::Accessors::BetweenEachAccessor)
   def between_each
-    self.then(Accessory::BetweenEachAccessor.new)
+    self.then(Accessory::Accessors::BetweenEachAccessor.new)
   end
 
-  # (see Accessory::AllAccessor)
+  # (see Accessory::Accessors::AllAccessor)
   def all
-    self.then(Accessory::AllAccessor.new)
+    self.then(Accessory::Accessors::AllAccessor.new)
   end
 
-  # (see Accessory::FirstAccessor)
+  # (see Accessory::Accessors::FirstAccessor)
   def first
-    self.then(Accessory::FirstAccessor.new)
+    self.then(Accessory::Accessors::FirstAccessor.new)
   end
 
-  # (see Accessory::LastAccessor)
+  # (see Accessory::Accessors::LastAccessor)
   def last
-    self.then(Accessory::LastAccessor.new)
+    self.then(Accessory::Accessors::LastAccessor.new)
   end
 
-  # (see Accessory::FilterAccessor)
+  # (see Accessory::Accessors::FilterAccessor)
   def filter(&pred)
-    self.then(Accessory::FilterAccessor.new(pred))
+    self.then(Accessory::Accessors::FilterAccessor.new(pred))
   end
 end
 

data/lib/accessory/accessor.rb

@@ -19,7 +19,7 @@ module Accessory; end
 # info):
 #
 # * {Accessor#traverse}
-# * {Accessor#default_data_constructor}
+# * {Accessor#ensure_valid}
 
 class Accessory::Accessor
   TERMINAL_DEFAULT_FN = lambda{ nil }
@@ -78,16 +78,13 @@ class Accessory::Accessor
   # call <tt>traverse_or_default(data)</tt> within your implementation to safely
   # get a traversal-result to operate on.
   #
-  # This method will return +nil+ if the input-data is +nil+, _without_ calling
-  # your {traverse} callback. This means that accessors that use
-  # {traverse_or_default} will _forward_ +nil+ traversal-results along the chain
-  # without being confused by them.
-  #
-  # If your {traverse} callback returns <tt>:error</tt>, a default value will
-  # be used. This is either the +default+ passed to {initialize} by your
-  # implementation calling <tt>super(default)</tt>; or it's the result of
-  # calling {default_data_constructor} on the successor-accessor in the accessor
-  # chain.
+  # The value returned by your {traverse} callback will be validated by your
+  # calling the {ensure_valid} callback of the _successor accessor_ in the Lens
+  # path. {ensure_valid} will replace any value it considers invalid with a
+  # reasonable default. This means you don't need to worry about what will
+  # happen if your traversal doesn't find a value and so returns +nil+. The
+  # successor's {ensure_valid} will replace that +nil+ with a value that works
+  # for it.
   def traverse_or_default(data)
     traversal_result = traverse(data) || @default_value
 
@@ -214,3 +211,5 @@ class Accessory::Accessor
 
   # @!endgroup
 end
+
+module Accessory::Accessors; end

data/lib/accessory/accessors/all_accessor.rb

@@ -15,7 +15,7 @@ require 'accessory/accessor'
 #
 # * +Array.new+
 
-class Accessory::AllAccessor < Accessory::Accessor
+class Accessory::Accessors::AllAccessor < Accessory::Accessor
   # @!visibility private
   def ensure_valid(traversal_result)
     if traversal_result.kind_of?(Enumerable)

data/lib/accessory/accessors/attribute_accessor.rb

@@ -19,7 +19,7 @@ require 'accessory/accessor'
 #
 # * +OpenStruct.new+
 
-class Accessory::AttributeAccessor < Accessory::Accessor
+class Accessory::Accessors::AttributeAccessor < Accessory::Accessor
   # @param attr_name [Symbol] the attribute name (i.e. name of the getter method)
   # @param default [Object] the default to use if the predecessor accessor passes +nil+ data
   def initialize(attr_name, default: nil)

data/lib/accessory/accessors/between_each_accessor.rb

@@ -16,7 +16,7 @@ require 'accessory/traversal_position/enumerable_before_offset'
 #
 # * +Array.new+
 
-class Accessory::BetweenEachAccessor < Accessory::Accessor
+class Accessory::Accessors::BetweenEachAccessor < Accessory::Accessor
   # @!visibility private
   def ensure_valid(traversal_result)
     if traversal_result.kind_of?(Enumerable)

data/lib/accessory/accessors/betwixt_accessor.rb

@@ -26,7 +26,7 @@ require 'accessory/traversal_position/enumerable_before_offset'
 #
 # * +Array.new+
 
-class Accessory::BetwixtAccessor < Accessory::Accessor
+class Accessory::Accessors::BetwixtAccessor < Accessory::Accessor
   # @param offset [Integer] the cursor position (i.e. the index of the element after the cursor)
   # @param default [Object] the default to use if the predecessor accessor passes +nil+ data
   def initialize(offset, default: nil)

data/lib/accessory/accessors/filter_accessor.rb

@@ -15,7 +15,7 @@ require 'accessory/accessor'
 #
 # * +Array.new+
 
-class Accessory::FilterAccessor < Accessory::Accessor
+class Accessory::Accessors::FilterAccessor < Accessory::Accessor
   # Returns a new instance of {FilterAccessor}.
   #
   # The predicate function may be passed in as either a positional argument,

data/lib/accessory/accessors/first_accessor.rb

@@ -15,7 +15,7 @@ require 'accessory/accessor'
 #
 # * +Array.new+
 
-class Accessory::FirstAccessor < Accessory::Accessor
+class Accessory::Accessors::FirstAccessor < Accessory::Accessor
   # @!visibility private
   def ensure_valid(traversal_result)
     if traversal_result.kind_of?(Enumerable)

data/lib/accessory/accessors/instance_variable_accessor.rb

@@ -14,7 +14,7 @@ require 'accessory/accessor'
 #
 # * +Object.new+
 
-class Accessory::InstanceVariableAccessor < Accessory::Accessor
+class Accessory::Accessors::InstanceVariableAccessor < Accessory::Accessor
   # @param ivar_name [Symbol] the instance-variable name
   # @param default [Object] the default to use if the predecessor accessor passes +nil+ data
   def initialize(ivar_name, default: nil)

data/lib/accessory/accessors/last_accessor.rb

@@ -15,7 +15,7 @@ require 'accessory/accessor'
 #
 # * +Array.new+
 
-class Accessory::LastAccessor < Accessory::Accessor
+class Accessory::Accessors::LastAccessor < Accessory::Accessor
   # @!visibility private
   def ensure_valid(traversal_result)
     if traversal_result.kind_of?(Enumerable)

data/lib/accessory/accessors/subscript_accessor.rb

@@ -31,7 +31,7 @@ require 'accessory/accessor'
 #
 # Other accessors ({FirstAccessor}, {BetwixtAccessor}, etc.) may fit your expectations more closely for +Array+ traversal.
 
-class Accessory::SubscriptAccessor < Accessory::Accessor
+class Accessory::Accessors::SubscriptAccessor < Accessory::Accessor
   # @!visibility private
   def initialize(key, **kwargs)
     super(**kwargs)

data/lib/accessory/lens.rb

@@ -200,9 +200,9 @@ class Accessory::Lens
       when Accessory::Accessor
         part
       when Array
-        Accessory::SubscriptAccessor.new(part[0], default: part[1])
+        Accessory::Accessors::SubscriptAccessor.new(part[0], default: part[1])
       else
-        Accessory::SubscriptAccessor.new(part)
+        Accessory::Accessors::SubscriptAccessor.new(part)
       end
 
     unless @parts.empty?

data/lib/accessory/version.rb

@@ -1,3 +1,3 @@
 module Accessory
-  VERSION = "0.1.6"
+  VERSION = "0.1.7"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: accessory
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Levi Aul