darthjee-core_ext 1.7.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 103b4b6d1acc61970210009223f1dafb42ffe566
-  data.tar.gz: 6887e4ef498e5e8edaa14c604ac8b79b91f9e709
+  metadata.gz: 8fa1c8ad67a3ebb2c4e0d3e44d2ece2404cb679e
+  data.tar.gz: 2362ff51b7d433bc82fb51314496af9801145bde
 SHA512:
-  metadata.gz: 21eed9f42d42a66a273413cdd784b32e3f1b07b9be39e6c34e8dba7162c442ad2cb4b96be93177a4d6b33e87e20365524b4e5d72bccbe27cbc22d1f0943c28db
-  data.tar.gz: 6de12c71400aa5f5cbd50b7614df418c50815ddf4f222cfe56b3cc852acbd2a745108e3f56394f065de4fb9c518fe02b0a77ddc02669f626b17f0c77b7b17054
+  metadata.gz: ac6b7fe0376149cb813893fdb64822f69e0f78972b21bb19d8d1be2192b395b386a2d565956197c613576aff80075d1eb609683af342a3b0728553c6fb32e9a8
+  data.tar.gz: 278121be9eb0a87815c2b878059a37c583b27296d9667c848e75a9f05bdd4b09b85051a0f2c254aafbb83da0691d6fa6fe5d611810536bac3e62b3056b52701f

data/.circleci/config.yml

@@ -2,7 +2,7 @@ version: 2
 jobs:
   build:
     docker:
-      - image: darthjee/circleci_ruby_240:0.1.0
+      - image: darthjee/circleci_ruby_gems_240:0.0.2
     steps:
       - checkout
       - run:
@@ -23,3 +23,9 @@ jobs:
       - run:
           name: Yardstick coverage check
           command: bundle exec rake verify_measurements
+      - run:
+          name: Check version documentation
+          command: scripts/check_readme.sh
+      - run:
+          name: Rubycritcs check
+          command: scripts/rubycritic.sh

data/.gitignore

@@ -4,3 +4,5 @@ Gemfile.lock
 doc
 .yardoc
 measurement
+rubycritic
+**/.*.swp

data/.reek.yml

@@ -0,0 +1,3 @@
+detectors:
+  BooleanParameter:
+    enabled: false

data/ARRAY_README.md

@@ -1,19 +1,26 @@
 ## Array
-### #average
-returns the average of the values in the array
+
+### #as_hash
+Creates a hash from the array using the argument array as keys
 
 ```ruby
-array = [1, 2, 3, 4]
-array.average # returns 2.5
+array = [10, 20, 30, 40]
+keys  = %i[ten twenty thirty fourty]
+
+array.as_hash(keys) # returns {
+                    #   ten: 10,
+                    #   twenty: 20,
+                    #   thirty: 30,
+                    #   fourty: 40
+                    # }
 ```
 
-### #map_to_hash
-map returning a hash with the original array for keys
+### #average
+Returns the average of the values in the array
 
 ```ruby
-array = %w(a ab)
-arrays.map_to_hash { |val| val.length }
-{ 'a' => 1, 'b' => 2 }
+array = [1, 2, 3, 4]
+array.average # returns 2.5
 ```
 
 ### #chain_map
@@ -22,7 +29,8 @@ applies map in a chain
 ```ruby
 array = [ :a, :long_name, :sym ]
 array.chain_map(:to_s, :size, :to_s)
-[ '1', '9', '3' ]
+
+# returns [ '1', '9', '3' ]
 ```
 
 ```ruby
@@ -31,13 +39,62 @@ array.chain_map(:to_s, :size) { |v| "final: #{v}" }
 [ 'final: 1', 'final: 9', 'final: 3' ]
 ```
 
-### #as_hash
-Creates a hash from the array using the argumen array as keys
+### #mapk
+Maps by fetching values from hashes inside array
+
+```ruby
+array = [
+  { a: { b: 1 }, b: 2 },
+  { a: { b: 3 }, b: 4 }
+]
+
+array.mapk(:a, :b) # return [1, 3]
+```
+
+### #procedural_join
+Maps values to strings and joins then by evaluating which
+string to be used on joining
 
 ```ruby
-  [1, 2, 3].as_hash %w(a b c)
+mapper = proc { |value| value.to_f.to_s }
+array.procedural_join(mapper) do |_previous, nexte|
+  nexte.positive? ? ' +' : ' '
+end     # returns '1.0 +2.0 -3.0 -4.0 +5.0'
 ```
-returns
+
+### #random
+Returns a random element of the array
+
 ```ruby
-  { 'a' => 1, 'b' => 2, 'c' => 3 } }
+array = [10, 20, 30]
+array.random                  # returns any of the elements
+array.include?(array.random!) # returns true
 ```
+
+### #random!
+Removes a random element of the array
+
+```ruby
+array = [10, 20, 30]
+array.random! # returns any of the elements
+
+array = [10, 20, 30]
+array.include?(array.random!) # returns false
+```
+
+## Added by Enumerable
+- [#clean](ENUMERABLE_README.md#clean)
+- [#clean!](ENUMERABLE_README.md#clean!)
+- [#map_and_find](ENUMERABLE_README.md#map_and_find)
+- [#map_and_select](ENUMERABLE_README.md#map_and_select)
+- [#map_to_hash](ENUMERABLE_README.md#map_to_hash)
+
+## Added by Object
+- [#is_any?](OBJECT_README.md#is_any?)
+- [#trueful?](OBJECT_README.md#trueful?)
+
+## Added by Class
+- [.default_value](CLASS_README.md#default_value)
+- [.default_values](CLASS_README.md#default_values)
+- [.default_reader](CLASS_README.md#default_reader)
+- [.default_readers](CLASS_README.md#default_readers)

data/CLASS_README.md

@@ -0,0 +1,154 @@
+## Class
+
+### #default_value
+Adds a method that will return a default value
+
+the value is evaluated on class definition, meaning that
+everytime it is called it will be the same instance
+
+```ruby
+class MyClass
+  default_value :name, 'John'
+end
+
+MyClass.new.name # returns 'John'
+```
+
+```ruby
+class MyClass
+  default_value :name, 'John'
+end
+
+instance = MyClass.new
+other = MyClass.new
+
+instance.name.equal?('John')      # returns false
+instance.name.equal?(other.name)  # returns true
+```
+
+### #default_values
+Adds methods that will return a default value
+
+the value is evaluated on class definition, meaning that
+everytime any of them are called they will return the same instance
+of value
+
+```ruby
+class MyClass
+  default_values :name, :nick_name, 'John'
+end
+
+MyClass.new.name      # returns 'John'
+MyClass.new.nick_name # returns 'John'
+```
+
+```ruby
+class MyClass
+  default_values :name, :nick_name, 'John'
+end
+
+instance = MyClass.new
+other = MyClass.new
+
+instance.name.equal?('John')     # returns false
+instance.name.equal?(other.name) # returns true
+```
+
+```ruby
+class MyClass
+  default_values :name, :nick_name, 'John'
+end
+
+instance = MyClass.new
+
+instance.nick_name.equal?('John')        # returns false
+instance.nick_name.equal?(instance.name) # returns true
+```
+
+### #default_reader
+Creates a method that will act as reader, but will
+return a default value when the instance variable
+was never set
+
+```ruby
+class Person
+  attr_writer :name
+  default_reader :name, 'John Doe'
+end
+
+model = Person.new
+
+model.name # returns 'John Doe'
+```
+
+```ruby
+model = Person.new
+model.name # returns 'John Doe'
+
+model.name = 'Joe'
+model.name # returns 'Joe'
+
+model.name = nil
+model.name # returns nil
+```
+
+```ruby
+model = Person.new
+model.name # returns 'John Doe'
+
+model.name = 'Bob'
+model.name # returns 'Bob'
+Person.new.name # returns 'John Doe'
+```
+
+### #default_readers
+Creates methods that will act as readers, but will
+return a default value when the instance variables
+ware never set
+
+```ruby
+class Person
+  attr_writer :cars, :houses
+  default_reader :cars, :houses, 'none'
+end
+
+model = Person.new
+
+model.cars # returns 'none'
+```
+
+```ruby
+model = Person.new
+model.cars # returns 'none'
+
+model.cars = ['volvo']
+model.cars # returns ['volvo']
+
+model.cars = nil
+model.cars # returns nil
+```
+
+```ruby
+model = Person.new
+model.cars # returns 'none'
+
+model.cars = ['volvo']
+model.cars # returns ['volvo']
+Person.new.houses # returns 'none'
+```
+
+```ruby
+model.cars                           # returns 'none'
+model.cars.equal?('none')            # returns false
+model.nick_name.equal?(model.houses) # returns true
+```
+
+## Added by Object
+- [#is_any?](OBJECT_README.md#is_any?)
+- [#trueful?](OBJECT_README.md#trueful?)
+
+## Added by Class
+- [.default_value](CLASS_README.md#default_value)
+- [.default_values](CLASS_README.md#default_values)
+- [.default_reader](CLASS_README.md#default_reader)
+- [.default_readers](CLASS_README.md#default_readers)

data/DATE_README.md

@@ -5,15 +5,25 @@
 Returns the number of days between 2 dates
 
 ```ruby
-d1 = Date.new(2106, 10, 11)
-d2 = d1 + 1.year
-d3 = d1 - 1,year
-```
+date   = Date.new(2106, 10, 11)
+future = date + 1.year
+past   = date - 1.year
 
-```ruby
-d1.days_between(d2) == 365
-```
+date.days_between(future)
 
-```ruby
-d1.days_between(d3) = 366
+# returns 365
+
+date.days_between(past)
+
+# returns 366
 ```
+
+## Added by Object
+- [#is_any?](ENUMERABLE_README.md#is_any?)
+- [#trueful?](ENUMERABLE_README.md#trueful?)
+
+## Added by Class
+- [.default_value](CLASS_README.md#default_value)
+- [.default_values](CLASS_README.md#default_values)
+- [.default_reader](CLASS_README.md#default_reader)
+- [.default_readers](CLASS_README.md#default_readers)

data/Dockerfile

@@ -1,9 +1,6 @@
-FROM darthjee/ruby_240:0.2.2
+FROM darthjee/ruby_gems_240:0.0.2
 
 USER app
-COPY ./ /home/app/app/
+COPY --chown=app ./ /home/app/app/
 
-RUN gem uninstall bundler
-RUN gem install bundler -v '1.17.3'
 RUN bundle install
-

data/ENUMERABLE_README.md

@@ -1,12 +1,162 @@
 ## Enumerable
 
+### #clean
+Retruns a copy of the enumerator removing empty values from it
+
+```ruby
+  hash  = { b: [], c: nil, d: {}, e: '' }
+  array = [1, [], nil, {}, '', hash]
+
+  array.clean # returns [1]
+```
+
+
 ### #clean!
-Cleans empty values from a hash
+Cleans empty values from an enumerator
+
+```ruby
+hash = {
+  a: 1,
+  b: [],
+  c: nil,
+  d: {},
+  e: '',
+  f: {
+    b: [],
+    c: nil,
+    d: {},
+    e: ''
+  }
+}
+
+hash.clean! # changes hash to { a: 1 }
+```
+
+### #map_and_find
+
+Applies ```#map``` stoping and returning on the first result
+that is evaluated as false
+
+```ruby
+class Client
+  def initialize(existing_ids)
+    @existing_ids = existing_ids
+  end
+
+  def request(id)
+    requested << id
+
+    return unless existing_ids.include?(id)
+    { id: id }
+  end
+
+  def requested
+    @requested ||= []
+  end
+
+  private
+
+  attr_reader :existing_ids
+end
+
+client = Client.new([1, 11, 21, 31, 41, 51])
+
+ids = [10, 21, 30, 31, 51, 55]
+
+ids.map_and_find { |id| client.request(id) } # returns { id: 21 }
+
+client.requested # returns [10, 21]
+```
+
+### #map_and_select
+
+Maps returning only non-false and non-nil values
+
 ```ruby
-{ a: 1, b: [], c: nil, d: {}, e: '', f: { b: [], c: nil, d: {}, e: '' } }.clean!
+class Client
+  def initialize(existing_ids)
+    @existing_ids = existing_ids
+  end
+
+  def request(id)
+    requested << id
+
+    return unless existing_ids.include?(id)
+    { id: id }
+  end
+
+  def requested
+    @requested ||= []
+  end
+
+  private
+
+  attr_reader :existing_ids
+end
+
+client = Client.new([1, 11, 21, 31, 41, 51])
+
+ids = [10, 21, 30, 31, 51, 55]
+
+ids.map_and_select do |id|
+  client.request(id)
+end                   # returns [{
+                      #   id: 21
+                      # }, {
+                      #   id: 31
+                      # }, {
+                      #   id: 51
+                      # }]
 ```
-returns
+
+### #map_to_hash
+Maps and uses mapped values as hash values, and original values
+as hash keys
+
 ```ruby
-  {}
+class Client
+  def initialize(existing_ids)
+    @existing_ids = existing_ids
+  end
+
+  def request(id)
+    requested << id
+
+    return unless existing_ids.include?(id)
+    { id: id }
+  end
+
+  def requested
+    @requested ||= []
+  end
+
+  private
+
+  attr_reader :existing_ids
+end
+
+client = Client.new([1, 11, 21, 31, 41, 51])
+
+ids = [10, 21, 30, 31, 51, 55]
+
+ids.map_to_hash do |id|
+  client.request(id)
+end                   # returns {
+                      #   10 => nil,
+                      #   21 => { id: 21 },
+                      #   30 => nil,
+                      #   31 => { id: 31 },
+                      #   51 => { id: 51 },
+                      #   55 => nil
+                      # }
 ```
 
+## Added by Object
+- [#is_any?](OBJECT_README.md#is_any?)
+- [#trueful?](OBJECT_README.md#trueful?)
+
+## Added by Class
+- [.default_value](CLASS_README.md#default_value)
+- [.default_values](CLASS_README.md#default_values)
+- [.default_reader](CLASS_README.md#default_reader)
+- [.default_readers](CLASS_README.md#default_readers)