enum_args 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d30df69cd412bd2fd7ab806e32739eb3283058fd
-  data.tar.gz: 54bf76bb749fdff1b1aa5bc5af29974ae4ad9228
+  metadata.gz: c4ec59ecef09b36ae718c8b4e15386620803a609
+  data.tar.gz: b986fb672cac0ef9bb05408baa499885a3124779
 SHA512:
-  metadata.gz: d8f79beac8e7242382e529b1e6853c6f23516c075dd8629cde523e8d270d58a4351f9e401713383e7838482a499cc29cadafe46ad2c75c08b36a04c2d9b53297
-  data.tar.gz: 390433118a98e132fb0bf2ab34295060af0236d37aa21d9fcdfa0f2856d7c3b56a91be45916544c374e5e58729d7b3f012c0b8e95a5e95394d374b4c77af01aa
+  metadata.gz: 45c8476b26ea171fec07746bd53c7f56e45f8ef3e5126d11456c11448d4215fad3785c5ab18de5a2b55c695df4f36e06118ca0811471115081e6f6cfeee49b1e
+  data.tar.gz: a5462e8eecf041017b4a44a83df9a4502ef22cf43a22c9bf1080fb2897181fcc9badf4c9e9297d8a64d13879b1ed22ed0fb32c870dedaedcdc6f1adff249a819

data/README.md

@@ -9,6 +9,17 @@ could, ie. `ai_team.select(max_cpu: 80) { |troop| troop.can_hit?(enemy) }.each
 
 See Usage for some examples.
 
+### Namespace pollution
+
+A common issue with this sort of gems is namespace pollution. EnumArgs is wise
+enough to pollute your namespace with the bare minimum needed.
+
+All of this is done by adding, apart from the Enumerable instance methods, _one_
+single accessor (instance) method to your class and _one_ single instance variable
+with configurable name (default is `enum_args`). A few _class_ methods are added
+to hold default values for your enumerator, all of them prefixed with
+`enum_args_`.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -42,7 +53,7 @@ class MyCollection
   end
 
   def each(pause = 1, verbose = false)
-    return enum_for(:each, pause) unless block_given?
+    return enum_for(:each, pause, verbose) unless block_given?
     ary.each do |element|
       yield element
       puts "sleeping for #{pause} secs" if verbose
@@ -74,14 +85,14 @@ not exactly ergonomic. But what happens if I wanted to suddenly increase the
 pause time used to 5 secs?
 
 ```ruby
-enumerator.each(10) do |elements|
+enumerator.each(10) do |element|
   puts "This does not quite work"
 end
 ```
 
 Well, we could do better, see:
 ```ruby
-collection.each(5) do |elements|
+collection.each(5) do |element|
   puts "This does work indeed!"
 end
 ```
@@ -91,8 +102,8 @@ whole process again... Except you'll soon discover this:
 
 ```ruby
 # won't work :(
-collection.select(5) do |e|
-  e.odd?
+collection.select(5) do |element|
+  element.odd?
 end
 ```
 
@@ -167,7 +178,7 @@ methods. The instance method you will get is `enum_args`, which is the actual
 enumerator that will use your iterator method.
 
 If that bothers you, you can change it by specifiyng a different symbol to
-`enum_args_for` using the `with_enum_as: :your_symbol` keyword argument.
+`enum_args_for` using the `with_enum_args_as: :your_symbol` keyword argument.
 
 ## Development
 

data/lib/enum_args/proxied_enumerable.rb

@@ -5,28 +5,28 @@ module EnumArgs
 
   module ProxiedEnumerable
     module ClassMethods
-      def enum_method
-        @enum_method ||= :iterator
+      def enum_args_method
+        @enum_args_method ||= :iterator
       end
 
-      def enum_accessor_method
-        @enum_accessor_method ||= :enum_args
+      def enum_args_accessor_method
+        @enum_args_accessor_method ||= :enum_args
       end
 
-      def enum_default_args
-        @enum_default_args ||= []
+      def enum_args_default_args
+        @enum_args_default_args ||= []
       end
 
-      def enum_default_using
-        @enum_default_using ||= {}
+      def enum_args_default_using
+        @enum_args_default_using ||= {}
       end
 
-      def enum_args_for(method, *args, using: {}, with_enum_as: :enum_args)
-        @enum_method = method
-        @enum_default_args = args
+      def enum_args_for(method, *args, using: {}, with_enum_args_as: :enum_args)
+        @enum_args_method = method
+        @enum_args_default_args = args
         raise TypeError, "expected Hash, found #{using.class}" unless using.is_a? Hash
-        @enum_default_using = using
-        @enum_accessor_method = with_enum_as
+        @enum_args_default_using = using
+        @enum_args_accessor_method = with_enum_args_as
       end
     end
 
@@ -43,24 +43,21 @@ module EnumArgs
     end
 
     on_enumerable_methods self do |*args, &blk|
-      send(self.class.enum_accessor_method).send __method__, *args, &blk
+      send(self.class.enum_args_accessor_method).send __method__, *args, &blk
     end
 
     def initialize(*args, &blk)
-      @enum_args = EnumArgs::Proxy.new self, self.class.enum_method, *self.class.enum_default_args, using: self.class.enum_default_using
-      define_singleton_method(self.class.enum_accessor_method) do
-        instance_variable_get('@enum_args')
+      klass = self.class
+      name = klass.enum_args_accessor_method
+      instance_variable_set(
+        "@#{name}",
+        EnumArgs::Proxy.new(self, klass.enum_args_method, *klass.enum_args_default_args,
+                            using: klass.enum_args_default_using)
+      )
+      define_singleton_method(name) do
+        instance_variable_get("@#{name}")
       end
       super
     end
-
-    def enum_args=(*args)
-      @enum_args.args = args
-    end
-
-    def enum_using=(using)
-      raise TypeError, "expected Hash, found #{using.class}" unless using.is_a? Hash
-      @enum_args.using = using
-    end
   end
 end

data/lib/enum_args/proxy.rb

@@ -53,6 +53,7 @@ module EnumArgs
     end
 
     def reset_default_enum
+      raise TypeError, "expected Hash, found #{using.class}" unless using.is_a? Hash
       self.enum = build_enum
     end
 

data/lib/enum_args/version.rb

@@ -1,3 +1,3 @@
 module EnumArgs
-  VERSION = "1.0.1"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: enum_args
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Alejandro Martinez Ruiz