yep 0.0.0 → 3.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f21f4ad7229428a808d252aa5a322ea640394d7db976c48a445ddbac5f6ebca9
-  data.tar.gz: a76b70a6723454e34bb2267e5644dec0fbb458228968a7dc85f6334b76469c4f
+  metadata.gz: b940c82007e745b1f117e984e1d1d6a5b482a4b5901d266dcd18b5d550769266
+  data.tar.gz: 0a81b6fae45ceee23e8a54513a9a47adc1a5dec83b84a2c74f498c303682c462
 SHA512:
-  metadata.gz: 3e254ea0a473f0a6dbfe5e2fe360f79224268efe5b882080cc4545c4f7bc781bab4b29744e90fce878e8d070c39f5aaea6b5deeec40c5993d21b275b3766c22d
-  data.tar.gz: 226abe945d27ca517e781b7d2c65bbc3d12b6f9b0768b83a63cb83b920bde019bd9c33a9e90b47ce362b75a5a05c9d0e56a075277028edf435dc671d5ddbecbb
+  metadata.gz: 93682d1d007e3f722525e24e33cca67074d2054d3d009db7149362fd7167f8feafeb9bbbda573137049bf913d34f46ee6322610fe0d6e01d6d85c0df64137f0f
+  data.tar.gz: de8e87d2e85cdd2dd2f5d5325de2608b16a17bf69fe2b3aec268dc831ea724214afe0ae7a2e43a76e232c2241cef687c6cb465173bbf42a300c1ad357c087f79

data/.rubocop.yml

@@ -1,5 +1,6 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 3.0.2
+  NewCops: enable
 Metrics/LineLength:
   Max: 100
 Style/Documentation:
@@ -14,7 +15,10 @@ Metrics/ModuleLength:
 Metrics/BlockLength:
   Exclude:
     - "**/*test_*.rb"
-Lint/UselessComparison:
+Lint/BinaryOperatorWithIdenticalOperands:
+  Exclude:
+    - "**/*test_*.rb"
+Lint/IdentityComparison:
   Exclude:
     - "**/*test_*.rb"
 Layout/MultilineOperationIndentation:

data/.ruby-version

@@ -1 +1 @@
-2.6.0
+3.0.2

data/Gemfile.lock

@@ -1,37 +1,38 @@
 PATH
   remote: .
   specs:
-    yep (0.0.0)
+    yep (3.0.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
-    ast (2.4.0)
-    jaro_winkler (1.5.2)
-    parallel (1.14.0)
-    parser (2.6.0.0)
-      ast (~> 2.4.0)
-    powerpack (0.1.2)
-    psych (3.1.0)
+    ast (2.4.2)
+    parallel (1.21.0)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
-    rubocop (0.65.0)
-      jaro_winkler (~> 1.5.1)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.22.3)
       parallel (~> 1.10)
-      parser (>= 2.5, != 2.5.1.1)
-      powerpack (~> 0.1)
-      psych (>= 3.1.0)
+      parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.12.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (~> 1.4.0)
-    ruby-progressbar (1.10.0)
-    unicode-display_width (1.4.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.13.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
-  ruby
+  x86_64-linux
 
 DEPENDENCIES
   rubocop
   yep!
 
 BUNDLED WITH
-   2.0.1
+   2.2.22

data/README.md

@@ -19,7 +19,7 @@ gem 'yep'
 ## Usage
 
 In the following example we will use a simple convoluted application that
-queries an external API for some data.
+queries an external API for user data.
 
 ```ruby
 require 'net/http'
@@ -48,18 +48,22 @@ end
 ```
 
 The problem with the code above is that the `User` class has a hard dependency
-on `RandomUserRepository`. This has two negative side effects. It would not be
-simple in a larger application to swap out the `RandomUserRepository` for
-another underlying repository such as `SqlUserRepository`. It's not simple
-to swap out the `RandomUserRepository` for testing purposes, maybe for
-something like `TestUserRepository`.
+on the `RandomUserRepository`. This has two negative side effects. 
 
-So lets have a look at dependency injection with yep to see how this can be
+It would not be simple in a larger application to swap out the
+`RandomUserRepository` and all the places it ends up being littered throughout
+the application for another implementation of the repository such as
+`SqlUserRepository`. 
+
+It would not be simple and concise to swap out the `RandomUserRepository` for
+testing purposes, maybe for something like a `TestUserRepository`.
+
+So lets have a look at dependency injection with `yep` to see how this can be
 solved.
 
 ### Container
 
-The container will hold dependencies registered under keys which can then later
+The container will store dependencies registered under keys which can then later
 be resolved. Registration of dependencies should happen once for an application.
 
 ```ruby
@@ -77,8 +81,8 @@ end
 App.boot
 ```
 
-During registration we register a class under a key then assign a lifetime to
-the registered class. 
+During boot we register classes under a keys then assign a lifetime to the
+registered classes. 
 
 If `Yep::Container::SINGLETON` is used as a lifetime, every time the dependency
 is resolved the container will return the same instance of a class.
@@ -114,7 +118,7 @@ registered dependency, in this case `repository`. Now by calling
 container.
 
 If at anytime you wanted to swap out and use a different repository, as long
-as it has the same method signatures and return the same data structures, you
+as it has the same method signatures and returns the same data structures, you
 can just change the dependency on the container.
 
 Example:
@@ -123,7 +127,7 @@ A new repository that reads from a SQL database.
 
 ```ruby
 class SqlUserRepository
-  include SomeSqlModule
+  include Sql
 
   class << self
     def random
@@ -159,7 +163,7 @@ programmatically resolve a dependency from the container.
 
 ### Testing
 
-During testing you may want to mock how the dependences are resolved.
+When testing you may want to mock how the dependences are resolved.
 
 In this example we mock the Users repository call to return a reliable set of
 data for testing.
@@ -200,3 +204,24 @@ is then unmocked (returned back to it's original state)
 ## Licence
 
 See `LICENCE` file.
+
+## Development
+
+### Prerequisites
+
+* Docker Community Edition - https://www.docker.com/community-edition
+* Docker Compose - https://docs.docker.com/compose/
+* Make - https://www.gnu.org/software/make/
+
+### Setup
+
+* `make` will build the application ready for use.
+
+### Lint
+
+* `make lint` will run linting
+
+### Tests
+
+* `make spec` will run tests
+

data/lib/yep/version.rb

@@ -1,3 +1,3 @@
 module Yep
-  VERSION = '0.0.0'.freeze
+  VERSION = '3.0.2'.freeze
 end

data/test/test_yep.rb

@@ -1,5 +1,8 @@
+require 'bundler'
 require 'minitest/autorun'
 
+Bundler.require
+
 require 'yep'
 
 class TestYep < Minitest::Test

data/yep.gemspec

@@ -1,4 +1,5 @@
 $LOAD_PATH.push File.expand_path('lib', __dir__)
+
 require 'yep/version'
 
 Gem::Specification.new do |s|
@@ -16,4 +17,5 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`
     .split("\n").map { |f| File.basename(f) }
   s.require_paths = ['lib']
+  s.required_ruby_version = '> 3.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yep
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 3.0.2
 platform: ruby
 authors:
 - Dan Watson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-05 00:00:00.000000000 Z
+date: 2021-11-10 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -39,16 +39,16 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.1
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
 summary: Yep is a dependency injection framework written in ruby