toolrack 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9de65ce9c244ee6178fcd96d2e1073dbd9067c7a1f9906e89de614e8a58c329f
+  data.tar.gz: f9943c8203a7cc47c0ab05557ed3c8ad327336288b439d736fc15f7b78deee51
+SHA512:
+  metadata.gz: 03d12fe2c6e1da0c3581ab424a4145f88aad0f0afbca472f5f1c1e2257b93438fba2cfb6591a33eb730751977257adc74b01acd875ce4b54fa8ce46cb08297fe
+  data.tar.gz: 6d089a8429ce18c130fee89b5524a202f6860402b68d6111a1aca80240cf8ecaec38663af2f22a30c42784984c2995c54613d121ff11fcd5eaac27f45d593f82

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.7
+before_install: gem install bundler -v 2.1.4

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 chrisliaw@antrapol.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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in toolrack.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "minitest", "~> 5.0"

data/README.md

@@ -0,0 +1,60 @@
+# Toolrack
+
+Toolrack just the collection of utilities that helps in my code clarity
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'toolrack'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install toolrack
+
+## Usage
+
+Toolrack is meant to be utilities hence it is prefixed with an entity.
+Therefore the two utilities are both packaged in namespace:
+
+```ruby
+module Antrapol::MyToolRack::ConditionUtils
+end
+```
+
+```ruby
+module Antrapol::MyToolRack::ExceptionUtils
+end
+```
+ 
+Besides, all the utilities so far is a module by itself, which means it is meant to be included/extended into application classes.
+
+For example:
+```ruby
+class EditController
+  include Antrapol::MyToolRack::ConditionUtils
+  include Antrapol::MyToolRack::ExceptionUtils
+end
+```
+
+Currently it has only 2 modules:
+* Condition Utilities
+  * is_empty?(obj) - I find rather effort intensive to call if not (obj.nil? or obj.empty?) for items that I want to check for validity before process. Hence this method shall test for .nil?. If the object also respond to :empty? it shall be called again. For example integer type does not support .empty?
+
+* Exception Utilities
+  * raise_if_empty(obj, message, error) - Extension from the is_empty?() above, usually if it is empty, an exception shall be raised. It is just combined the conditions with raise of exception. 
+    * obj is the object to test for is_empty
+    * message is the one that shall be thrown with the exception. 
+    * error is the exception type 
+  * raise_if_false(obj, message, error) - As the name implied
+  * raise_if_true(obj, message, error) -  As the name implied
+
+
+ 
+

data/Rakefile

@@ -0,0 +1,10 @@
+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 "toolrack"
+
+# 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/toolrack/condition_utils.rb

@@ -0,0 +1,19 @@
+
+
+module Antrapol
+  module MyToolRack
+    module ConditionUtils
+
+      def is_empty?(obj)
+        if obj.nil?
+          true
+        elsif obj.respond_to?(:empty?)
+          obj.empty?
+        else
+          false
+        end
+      end # is_empty?
+
+    end # ConditionUtils
+  end # MyToolRack
+end # Antrapol

data/lib/toolrack/exception_utils.rb

@@ -0,0 +1,49 @@
+
+require_relative 'conditions_utils'
+
+module Antrapol
+  module MyToolRack
+    module ExceptionUtils
+      include Antrapol::MyToolRack::ConditionUtils
+
+      # raise_if_empty
+      # Raise the given (or default if not given) exception if the val given is empty
+      # val - variable/object that shall be tested for emptiness
+      # message - message to be thrown if it is true
+      # error - exception object to be thrown
+      def raise_if_empty(val, message, error = Antrapol::MyToolRack::Error)
+        raise_error(message,error) if is_empty?(val)
+      end # raise_if_empty
+
+      # 
+      # raise_if_false
+      #
+      def raise_if_false(bool, message, error = Antrapol::MyToolRack::Error)
+        if not bool
+          raise_error(message,error)
+        end 
+      end # raise_if_false
+
+      #
+      # raise_if_true
+      #
+      def raise_if_true(bool, message, error = Antrapol::MyToolRack::Error)
+        raise_if_false(!bool, message, error)
+      end # raise_if_true
+
+      protected
+      def raise_error(message, error = Antrapol::MyToolRack::Error)
+        if error.nil?
+          if @default_exception.nil?
+            raise Antrapol::MyToolRack::Error, message
+          else
+            raise @default_exception, message
+          end
+        else
+          raise error, message
+        end
+      end # raise_error
+      
+    end # ExceptionUtils
+  end # MyToolRack
+end # Antrapol

data/lib/toolrack/version.rb

@@ -0,0 +1,6 @@
+module Antrapol
+  module MyToolRack
+    VERSION = "0.1.0"
+  end
+end
+

data/lib/toolrack.rb

@@ -0,0 +1,11 @@
+require "toolrack/version"
+
+require_relative 'toolrack/exception_utils'
+require_relative 'toolrack/condition_utils'
+
+module Antrapol
+  module MyToolRack
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end

data/toolrack.gemspec

@@ -0,0 +1,28 @@
+require_relative 'lib/toolrack/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "toolrack"
+  spec.version       = Antrapol::MyToolRack::VERSION
+  spec.authors       = ["Chris"]
+  spec.email         = ["chrisliaw@antrapol.com"]
+
+  spec.summary       = %q{Collection of simple utilities but I find it increase clarity}
+  spec.description   = %q{Just collections of utilities}
+  spec.homepage      = ""
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #spec.metadata["homepage_uri"] = spec.homepage
+  #spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # 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('..', __FILE__)) 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"]
+end

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: toolrack
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-13 00:00:00.000000000 Z
+dependencies: []
+description: Just collections of utilities
+email:
+- chrisliaw@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/toolrack.rb
+- lib/toolrack/condition_utils.rb
+- lib/toolrack/exception_utils.rb
+- lib/toolrack/version.rb
+- toolrack.gemspec
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.8
+signing_key: 
+specification_version: 4
+summary: Collection of simple utilities but I find it increase clarity
+test_files: []