prime_products 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c89a59e2546e8634e232c6a6061743a774327d482bb8848f49dfbb9ac2dbf39e
-  data.tar.gz: 995d3b55063f6961309571a108abf290911c55feb6e33b0fa85a909ae6769e1d
+  metadata.gz: 33ac5620ba1e8f2ad6673b6a0594395d0228b8f79e3b576a0ef333474169bd06
+  data.tar.gz: 9b10d62cc31781174c261eb0496dd270b287613ab1b21aa6184d0913851e8269
 SHA512:
-  metadata.gz: 3137a492c281a242fa36e46a2fe3f3dda3ce4632ba91ab8e7594292f9a10f52fddbbb50ab25d374d0fce7c972eb942a842b29005f6db706ba49cd58cc7ce6154
-  data.tar.gz: 9fed6a69ea93e510de70f7a08aa18bb8bde65754cb37974367cbf2f04a638fc1840ebfea99b214901ab2c8e59b6d51932a9d09128deafd2dd1514b992ac391a5
+  metadata.gz: 11d1a587e00911b5c2199eea91465b6cf88d1159ee1474f0b09f8ae2fac9981dac0b4aedebc851d45b9dfb42ed9ed0b244ca2757102d51881f2e80f5c3b66ed0
+  data.tar.gz: f3f2cd5387c6d78787322fe0629023e7a9eb2f90081362d0d2577023611e25d190bb1cadaf646e8f9f76b2222920934a01c45bd8cfda23c45b50671e82832c5c

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# v0.1.1 (25 Nov 2018)
+
+* Rename `PrimeProducts::ProductsTable` to `PrimeProducts::MultiplicationTable`
+
+# v0.1.0 (25 Nov 2018)
+
+* Initial release

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prime_products (0.1.0)
+    prime_products (0.1.1)
       hanami-cli (~> 0.3.0)
       immutable-ruby (~> 0.0.3)
       terminal-table (~> 1.8.0)

data/README.md

@@ -35,6 +35,22 @@ prime_products 10
 
 If you do not provide an argument, we will use the first 5 by default.
 
+## Exploring the code
+
+The code is logically separated into parts, in line with the single responsibility principle.
+
+When you run the `prime_products` executable included with the gem, `exe/prime_products` is executed, which calls `PrimeProducts::CLI.call`.
+
+`PrimeProducts::CLI.call` defaults to outputting the `STDOUT` and reading input from `ARGV`, but this can be customised, allowing for a "dependency injection" approach to testing.
+
+It finds the number of primes to use, looking at `ARGV` and defaulting to `CLI::DEFAULT_NUMBER_OF_PRIMES` if no option has been provided.
+
+It then calls `PrimeProducts.generate_table` with the `number_of_primes`, and writes the result to the output,
+
+`PrimeProducts.generate_table` finds the requested number of prime numbers using `PrimeProducts::PrimeNumbers.first`, and then asks `PrimeProducts::MultiplicationTable.generate` to generate a multiplication table from them.
+
+`PrimeProducts::PrimeNumbers.first` uses a simple, naive but sufficiently performant method of finding the primes - see the "Benchmarking" section below - and returns them in an `Immutable::SortedSet` to avoid the danger of accidental mutation.
+
 ## Benchmarking
 
 This gem uses a naive method of finding the first *n* primes which does not scale especially well. However, this seems reasonable given that the primes will be displayed on-screen, and so it is unlikely you will want to see a large number at once.

data/lib/prime_products/{products_table.rb → multiplication_table.rb}

@@ -3,7 +3,7 @@
 require "terminal-table"
 
 module PrimeProducts
-  module ProductsTable
+  module MultiplicationTable
     class << self
       # Generates an ASCII "multiplication table" of the supplied `numbers`, suitable
       # for presentation in a shell.

data/lib/prime_products/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PrimeProducts
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/prime_products.rb

@@ -2,7 +2,7 @@
 
 require "prime_products/cli"
 require "prime_products/prime_numbers"
-require "prime_products/products_table"
+require "prime_products/multiplication_table"
 require "prime_products/version"
 
 module PrimeProducts
@@ -25,6 +25,6 @@ module PrimeProducts
   # @return [String] the generated table
   def self.generate_table(number_of_primes:)
     prime_numbers = PrimeNumbers.first(number_of_primes)
-    ProductsTable.generate(prime_numbers)
+    MultiplicationTable.generate(prime_numbers)
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prime_products
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Tim Rogers
@@ -149,10 +149,9 @@ files:
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
-- CODE_OF_CONDUCT.md
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
-- LICENSE.txt
 - README.md
 - Rakefile
 - benchmarks/prime_numbers.rb
@@ -161,8 +160,8 @@ files:
 - exe/prime_products
 - lib/prime_products.rb
 - lib/prime_products/cli.rb
+- lib/prime_products/multiplication_table.rb
 - lib/prime_products/prime_numbers.rb
-- lib/prime_products/products_table.rb
 - lib/prime_products/version.rb
 - prime_products.gemspec
 homepage: 

data/CODE_OF_CONDUCT.md

@@ -1,74 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as
-contributors and maintainers pledge to making participation in our project and
-our community a harassment-free experience for everyone, regardless of age, body
-size, disability, ethnicity, gender identity and expression, level of experience,
-nationality, personal appearance, race, religion, or sexual identity and
-orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment
-include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or
-advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable
-behavior and are expected to take appropriate and fair corrective action in
-response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or
-reject comments, commits, code, wiki edits, issues, and other contributions
-that are not aligned to this Code of Conduct, or to ban temporarily or
-permanently any contributor for other behaviors that they deem inappropriate,
-threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community. Examples of
-representing a project or community include using an official project e-mail
-address, posting via an official social media account, or acting as an appointed
-representative at an online or offline event. Representation of a project may be
-further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at me@timrogers.co.uk. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. The project team is
-obligated to maintain confidentiality with regard to the reporter of an incident.
-Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good
-faith may face temporary or permanent repercussions as determined by other
-members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2018 Tim Rogers
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in
-all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
-THE SOFTWARE.