todo_analyser 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5dad5c88918707ccb9b869c2cac95e6744e8878d287abd3183151ab0d2889af7
-  data.tar.gz: 62909da6b9f2793facd24961f6c19fb93466d729d336951508af4c43547bab11
+  metadata.gz: 3f63cc130bdfa8bf2b08af931bb7328f0a366f589755c67a074edfc5d7fc1b14
+  data.tar.gz: 3bba5cc07007e5a54d02ba6d724c413e32530b30baf0c142a6f90e5f78c6f835
 SHA512:
-  metadata.gz: 2a54af9513b56863365613056f727484e9a74dbbf301e51606a80c398393f1c8af4f87dfda915820abd654b762d11976c67491406eb1a688c15a34cb9d71e20b
-  data.tar.gz: 417368352ac62592f97a97815887f5d30f4c9def15b2f59383c539637224e095c5e85d951d1f366ab417c7d84247e73d1662c4d4cd569c41d53764d6be267cc2
+  metadata.gz: c00b2be314fc85b712846c5e9bbb2a53cea54028beb794a6d732698f856817eab4d5fa1eb70e4c9dfa049541afcaf5db691908c3aa40cbff3e6991ad6079ba85
+  data.tar.gz: 86a79e52c428ed05eb18f6492448a0e2b7f492b5b1bd7f066884a78795118e9ba5c8a96d005b0254c7f2daf31639c62b4cde2173fc6035c85c0b8b4c9cb413ee

data/Dockerfile

@@ -0,0 +1,16 @@
+FROM ruby:3.3-slim
+LABEL authors="sureshinde"
+
+RUN apt update && apt install -y git
+
+RUN bundle config --global frozen 1
+
+WORKDIR /app
+
+COPY Gemfile Gemfile.lock todo_analyser.gemspec ./
+
+COPY . .
+
+RUN bundle install
+
+ENTRYPOINT ["bin/console"]

data/README.md

@@ -22,23 +22,39 @@ If bundler is not being used to manage dependencies, install the gem by executin
 ## Usage
 
 ### Option 1: Console Command
-
     $ bin/console -h # To display information about command arguments
     $ bin/console <URL> [OPTIONS]
     $ OPTIONS: -n, --number N [Number of TODOs to consume (default: 20)]
 
-### Option 2: Standalone Command
+### Option 2: Bundle Command
+    $ bundle exec todo_analyser -h # To display information about command arguments
+    $ bundle exec todo_analyser <URL> [OPTIONS]
+
+### Option 3: Standalone Command
     $ run/todo_analyser.rb -h # To display information about command arguments
     $ run/todo_analyser.rb <URL> [OPTIONS]
 
-### Example: Option 1
+### Option 4: Docker Command
+    $ docker build -t todo_analyser .
+    $ docker run todo_analyser -h # To display information about command arguments
+    $ docker run todo_analyser <URL> [OPTIONS]
+
+### Example: Console Command
     $ bin/console https://jsonplaceholder.typicode.com/todos
     $ bin/console -n 10 https://jsonplaceholder.typicode.com/todos
 
-### Example: Option 2
+### Example: Bundle Command
+    $ bundle exec todo_analyser https://jsonplaceholder.typicode.com/todos
+    $ bundle exec todo_analyser -n 10 https://jsonplaceholder.typicode.com/todos
+
+### Example: Standalone Command
     $ run/todo_analyser.rb https://jsonplaceholder.typicode.com/todos
     $ run/todo_analyser.rb -n 10 https://jsonplaceholder.typicode.com/todos
 
+### Example: Docker Command
+    $ docker run todo_analyser https://jsonplaceholder.typicode.com/todos
+    $ docker run todo_analyser -n 10 https://jsonplaceholder.typicode.com/todos
+
 
 ## Contributing
 

data/exe/todo_analyser

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+# frozen_string_literal: true
+
+require 'todo_analyser'
+
+TodoAnalyser.run

data/lib/todo_analyser/version.rb

@@ -4,5 +4,5 @@
 # Versioning
 ##
 module TodoAnalyser
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/lib/todo_analyser.rb

@@ -13,24 +13,32 @@ require_relative 'todo_analyser/todo_consumer'
 module TodoAnalyser
   class Error < StandardError; end
 
-  # Command-line argument parsing
-  options = {}
-  OptionParser.new do |opts|
-    opts.banner = 'Usage: todo_analyser.rb URL [OPTIONS]'
-
-    opts.on('-n', '--number N', 'Number of TODOs to consume (default: 20)') do |n|
-      options[:number] = n.to_i
-    end
-  end.parse!
-
-  todos_path = ARGV[0]
-  raise 'Please specify a file to consume TODOs from.' unless todos_path
-
-  # Default Values
-  number = options[:number] || 20
-
-  # Calls
-  reader = TodoReaderJSON.new(todos_path)
-  consumer = TodoConsumer.new(reader, number, ConsoleOutput.new)
-  consumer.consume
+  def self.configure
+    # Command-line argument parsing
+    options = {}
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: todo_analyser.rb URL [OPTIONS]'
+
+      opts.on('-n', '--number N', 'Number of TODOs to consume (default: 20)') do |n|
+        options[:number] = n.to_i
+      end
+    end.parse!
+
+    [ARGV[0], options[:number] || 20]
+  end
+
+  def self.analyse(todos_path, number)
+    # Calls
+    reader = TodoReaderJSON.new(todos_path)
+    consumer = TodoConsumer.new(reader, number, ConsoleOutput.new)
+    consumer.consume
+  end
+
+  def self.run
+    todos_path, number = configure
+
+    raise 'Please specify a file to consume TODOs from.' unless todos_path
+
+    analyse(todos_path, number)
+  end
 end

data/run/todo_analyser.rb

@@ -8,7 +8,7 @@ require 'net/http'
 ##
 # Module to Run the Parser & Analyser
 ##
-module TodoAnalyser
+module StandAloneTodoAnalyser
   # Interface for reading the response
   module TodoReaderInterface
     def read
@@ -77,24 +77,34 @@ module TodoAnalyser
     end
   end
 
-  # Command-line argument parsing
-  options = {}
-  OptionParser.new do |opts|
-    opts.banner = 'Usage: todo_analyser.rb URL [OPTIONS]'
+  def self.configure
+    # Command-line argument parsing
+    options = {}
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: todo_analyser.rb URL [OPTIONS]'
 
-    opts.on('-n', '--number N', 'Number of TODOs to consume (default: 20)') do |n|
-      options[:number] = n.to_i
-    end
-  end.parse!
+      opts.on('-n', '--number N', 'Number of TODOs to consume (default: 20)') do |n|
+        options[:number] = n.to_i
+      end
+    end.parse!
+
+    [ARGV[0], options[:number] || 20]
+  end
 
-  todos_path = ARGV[0]
-  raise 'Please specify a file to consume TODOs from.' unless todos_path
+  def self.analyse(todos_path, number)
+    # Calls
+    reader = TodoReaderJSON.new(todos_path)
+    consumer = TodoConsumer.new(reader, number, ConsoleOutput.new)
+    consumer.consume
+  end
+
+  def self.run
+    todos_path, number = configure
 
-  # Default Values
-  number = options[:number] || 20
+    raise 'Please specify a file to consume TODOs from.' unless todos_path
+
+    analyse(todos_path, number)
+  end
 
-  # Calls
-  reader = TodoReaderJSON.new(todos_path)
-  consumer = TodoConsumer.new(reader, number, ConsoleOutput.new)
-  consumer.consume
+  run
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: todo_analyser
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Suresh Shinde
@@ -13,16 +13,19 @@ dependencies: []
 description: To-Do List Parser to parse the TODOs for even numbered items from list
 email:
 - sureshindes@gmail.com
-executables: []
+executables:
+- todo_analyser
 extensions: []
 extra_rdoc_files: []
 files:
 - ".rspec"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
+- Dockerfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- exe/todo_analyser
 - lib/todo_analyser.rb
 - lib/todo_analyser/console_output.rb
 - lib/todo_analyser/todo.rb