puts_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a3600f4b3b3cbf595d8e225e3c237c679c188eea1b3d5b7538720bc7cce9f03e
+  data.tar.gz: 847fea93057b530c4645c9aad96c89951cf85a8b14c0bd26c8e568f3894f25bf
+SHA512:
+  metadata.gz: 71df9abfd71a6710ea726fed8b934cb3118e4ffc7f750f3918da1382270614599351b7dc52835ec88bde7e3f5648017a4b6b4a0cb3a8e8f5cb829284c2665c7e
+  data.tar.gz: ec6b9a46af9929dc60459617a565adcfe34ff05142dd4b324952ad867e6885de4c76c1b951386c2727e5449c2287874ff41e69b3c8562d9c3c3f3989de8124e0

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - 'bin/**/*'
+
+Documentation:
+  Enabled: false
+
+Metrics/LineLength:
+  Max: 120

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# 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 lawrance.shepstone@gmail.com. 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/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in puts_utils.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Lawrance Shepstone
+
+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.

data/README.md

@@ -0,0 +1,86 @@
+# PutsUtils
+
+Prettier puts formatting for the lazy. Helpful utilities to puts in colour, tables and more.
+
+
+## Installation
+
+Add the following line to your application's Gemfile:
+
+```ruby
+gem 'puts_utils'
+```
+
+And then execute:
+
+    $ bundle 
+
+Or install it yourself as:
+
+    $ gem install puts_utils
+
+## Usage
+
+```ruby 
+require 'puts_utils'
+
+desc 'PutsUtils demo rake task'
+task puts_utils_demo: do
+
+  #
+  # Include any of the PutsUtils modules you'd like
+  #
+
+  include PutsUtils::PutsColor
+  include PutsUtils::PutsTable
+  include PutsUtils::PutsPrompt
+
+  #
+  # Use puts_color to puts in various colors
+  #
+
+  puts_color 'Danger.', :red
+  puts_color 'Done.', :green
+  puts_color 'Warning.', :yellow
+  puts_color 'Something.', :blue
+
+  #
+  # puts_color shorthand methods also available
+  #
+
+  puts_color_red 'Red'
+  puts_color_purple 'Purple'
+  puts_color_cyan 'Cyan'
+  puts_color_gray 'Grey'
+  puts_color_blue 'Blue'
+  puts_color_yellow 'Yellow'
+  puts_color_green 'Green'
+  
+  #
+  # Use puts_prompt to ask for inputs
+  #
+  
+  color = puts_prompt "What's your favourite colour?: ", required: true
+  
+  puts_color "You answered '#{color}'!", color.to_sym
+
+  #
+  # Use puts_table to display tabular data
+  #
+  
+  puts_table %w[Color Code] do
+    PutsUtils::PutsColor::COLOR_CODES.map do |color, code|
+      [color, code]
+    end
+  end
+end
+
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct	
+
+Everyone interacting in the PutsUtils project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/puts_utils/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "puts_utils"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/puts_utils.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'puts_utils/version'
+require 'puts_utils/puts_color'
+require 'puts_utils/puts_table'
+require 'puts_utils/puts_prompt'
+
+module PutsUtils
+end

data/lib/puts_utils/puts_color.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module PutsUtils
+  module PutsColor
+    COLOR_CODES = {
+      red: 31,
+      green: 32,
+      yellow: 33,
+      blue: 34,
+      purple: 35,
+      cyan: 36,
+      gray: 37
+    }.freeze
+
+    def puts_color(string, color = :gray)
+      puts "\e[#{COLOR_CODES[color]}m#{string}\e[0m"
+    end
+
+    COLOR_CODES.keys.each do |color|
+      define_method "puts_color_#{color}" do |string|
+        puts_color string, color
+      end
+    end
+  end
+end

data/lib/puts_utils/puts_prompt.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PutsUtils
+  module PutsPrompt
+    # rubocop: disable Metrics/CyclomaticComplexity
+    # rubocop: disable Metrics/MethodLength
+    def puts_prompt(question, required: false, default: nil)
+      tries = 1
+      loop do
+        STDOUT.print question
+        answer = STDIN.gets.strip
+        return answer if answer.present?
+        return default if answer.empty? && required == false
+        raise 'Value is required' if answer.empty? && required && tries == 3
+
+        puts 'Sorry, this is required – please try again'
+        tries += 1
+        next
+      end
+    end
+    # rubocop: enable Metrics/CyclomaticComplexity
+    # rubocop: enable Metrics/MethodLength
+  end
+end

data/lib/puts_utils/puts_table.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'puts_utils/puts_table/formatter'
+require 'puts_utils/puts_table/table'
+
+module PutsUtils
+  module PutsTable
+    def puts_table(headers = nil, data = nil)
+      data = yield if block_given?
+      table = Table.new(headers, data)
+      puts Formatter.new(table).to_s
+    end
+  end
+end

data/lib/puts_utils/puts_table/formatter.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module PutsUtils
+  module PutsTable
+    class Formatter
+      attr_reader :table
+
+      def initialize(table)
+        @table = table
+        @sizes = {}
+      end
+
+      def to_s
+        table.rows.map do |values|
+          render_row(values)
+        end.join("\n")
+      end
+
+      private
+
+      def render_row(values)
+        (+'').tap do |result|
+          values.each_with_index do |value, column|
+            result << format("%-#{size_of_column(column)}s\t", value)
+          end
+        end
+      end
+
+      def size_of_column(index)
+        key = index.to_s.to_sym
+        return @sizes[key] if @sizes.key?(key)
+
+        @sizes[key] = table.column(index)
+                           .map(&:to_s)
+                           .max_by(&:length)
+                           .length
+      end
+    end
+  end
+end

data/lib/puts_utils/puts_table/table.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module PutsUtils
+  module PutsTable
+    class Table
+      def initialize(headers, data)
+        @headers = headers || []
+        @data = data || []
+        @columns = {}
+      end
+
+      def rows
+        @rows ||= [@headers] + @data
+      end
+
+      def column(index)
+        key = index.to_s.to_sym
+        return @columns[key] if @columns.key?(key)
+
+        @columns[key] = rows.map { |r| r[index] }
+      end
+    end
+  end
+end

data/lib/puts_utils/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PutsUtils
+  VERSION = '0.1.0'
+end

data/puts_utils.gemspec

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'puts_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'puts_utils'
+  spec.version       = PutsUtils::VERSION
+  spec.authors       = ['Collaboration Collective']
+  spec.email         = ['hello@collabcollective.com']
+
+  spec.summary       = 'Prettier puts formatting for the lazy'
+  spec.description   = 'Helpful utilities to puts in colour, tables and more.'
+  spec.homepage      = 'https://github.com/collcoll/puts_utils'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rubocop', '~> 0.76'
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: puts_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Collaboration Collective
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-11-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.76'
+description: Helpful utilities to puts in colour, tables and more.
+email:
+- hello@collabcollective.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/puts_utils.rb
+- lib/puts_utils/puts_color.rb
+- lib/puts_utils/puts_prompt.rb
+- lib/puts_utils/puts_table.rb
+- lib/puts_utils/puts_table/formatter.rb
+- lib/puts_utils/puts_table/table.rb
+- lib/puts_utils/version.rb
+- puts_utils.gemspec
+homepage: https://github.com/collcoll/puts_utils
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/collcoll/puts_utils
+  source_code_uri: https://github.com/collcoll/puts_utils
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Prettier puts formatting for the lazy
+test_files: []