iamsure 0.1.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7d69627436946126f320e9f894de3b0d6e4e39de31aae25340bd6b17304115ac
-  data.tar.gz: d223cd05ddd508dfb4ddb276b5b06a80af3474926e1147a9f4d33c39736caaeb
+  metadata.gz: 000d74e4fd57b9e745e2b57511ef09611b53b1264453922c25dbd483bb7ef476
+  data.tar.gz: b4fbd274ce5d6d06d1415f0714f0f17fa9df43080fcbfb66ead42dbe59046c88
 SHA512:
-  metadata.gz: 32c625a41433fad92a72a1d860cf604ef821c3b8c3aebaea38c69433713e7ac661e7477673f8f2faa06a3650c0e12a48c15415112963f209958d58530bc8e917
-  data.tar.gz: 6942257f0edfebc116636e3c2f3c47b016d69b9417159ee93af3378bde74bd6270393369e8e17c03004c83f1595f17b5f4fe94bac95b6ee9d6f17b11c6fcddeb
+  metadata.gz: 852ec2f18776f69d534a4574c6a201698accf8313e9cce2cbb0596cf4c5adac88dafb21fbe779454121e1e21d7171c24ce9acbcb5d5e95241f9996902ae85b95
+  data.tar.gz: 9a4e6b1d0dc9a706207498ca8a5be00000979e0ba1027cd41591a0381e1cdc3d63748f55cdfddade69f919f39c7bbeb90669e41d14be03a33ae8a4395a3ed207

data/.gitignore

@@ -54,3 +54,5 @@ build-iPhoneSimulator/
 
 # Used by RuboCop. Remote config files pulled in from inherit_from directive.
 # .rubocop-https?--*
+
+.rspec_status

data/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ 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 TODO: Write your email address. All
+reported by contacting the project under the issues of the repository. 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.

data/Gemfile

@@ -2,3 +2,5 @@ source "https://rubygems.org"
 
 # Specify your gem's dependencies in iamsure.gemspec
 gemspec
+
+gem 'coveralls', require: false

data/Gemfile.lock

@@ -6,7 +6,15 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
     diff-lcs (1.3)
+    docile (1.3.2)
+    json (2.3.0)
     rake (13.0.1)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
@@ -21,12 +29,24 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-support (3.9.3)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
   bundler (~> 2.0)
+  coveralls
   iamsure!
   rake (~> 13.0)
   rspec (~> 3.9)

data/README.md

@@ -1,8 +1,9 @@
-# Iamsure
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iamsure`. To experiment with that code, run `bin/console` for an interactive prompt.
+![Travis (.org)](https://img.shields.io/travis/torokmark/iamsure)
+![Coveralls github](https://img.shields.io/coveralls/github/torokmark/iamsure)
+# Iamsure
 
-TODO: Delete this and the text above, and describe your gem
+IamSure is a precondition checker by chaining conditions next one another.
 
 ## Installation
 
@@ -22,7 +23,52 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+def fun(arg)
+  IamSure.of(arg)
+    .not_nil("argument cannot be null")
+    .get # => arg
+end
+```
+
+```ruby
+class CustomUnpacker < Iamsure::Unpacker
+  def unpack(arg)
+    "#{ arg }/some.rb"
+  end
+end
+
+class CustomInitiator < Iamsure::Initiator
+  def init(arg)
+    arg.to_s
+  end
+end
+
+def fun(arg)
+  IamSure.of(arg)
+    .not_nil('arg cannot be nil!')
+    .unpack(CustomUnpacker.new)
+    .not_empty("arg cannot be empty")
+    .exist(as: :file)
+    .get(CustomInitiator.new) # => 
+end
+```
+## Documentation
+
+`IamSure.of(arg): IamSure` creates new instance with the given argument.
+
+`IamSure#not_nil(msg): IamSure` check whether the value is not `nil`.
+
+`IamSure#not_empty(msg): IamSure` check whether the value is not empty.
+
+`IamSure#exist(as): IamSure` check whether the value is file (`as: :file`) or directory (`as: :dir`).
+
+`IamSure#unpack(unpacker): IamSure` transforms the value into a new one.
+
+`IamSure#get(initiator): object` returns the the checked object or its initiated value.
+
+
+
 
 ## Development
 
@@ -32,7 +78,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/iamsure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/torokmark/iamsure. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -40,4 +86,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Iamsure project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/iamsure/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Iamsure project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/torokmark/iamsure/blob/master/CODE_OF_CONDUCT.md).

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "iamsure"
+
+# 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/iamsure.gemspec

@@ -17,11 +17,11 @@ Gem::Specification.new do |spec|
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   if spec.respond_to?(:metadata)
-    #spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
-    #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."
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage 
+    #spec.metadata["changelog_uri"] = ""
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."

data/lib/iamsure.rb

@@ -1,5 +1,6 @@
 require "iamsure/version"
-
+require 'iamsure/initiator'
+require 'iamsure/unpacker'
 
 module Iamsure
   class IamSure
@@ -49,7 +50,7 @@ module Iamsure
 
     def get(initiator=nil)
       return @obj if initiator.nil?
-      return Initiator.new(@obj) if initiator.is_a?(Initiator)
+      return initiator.init(@obj) if initiator.is_a?(Iamsure::Initiator)
       raise ArgumentError.new "initiator should be empty or inherited from Initiator"
     end
   end

data/lib/iamsure/initiator.rb

@@ -1,6 +1,6 @@
   module Iamsure
     class Initiator
-      def initiate(arg)
+      def init(arg)
         raise 'It should be implemented in inherited class'
       end
     end

data/lib/iamsure/unpacker.rb

@@ -1,10 +1,7 @@
   module Iamsure
     class Unpacker
-      def initialize
-        raise 'Should be implemented in derived class'
-      end
-
       def unpack
+        raise 'Should be implemented in derived class'
       end
     end
   end

data/lib/iamsure/version.rb

@@ -1,3 +1,3 @@
 module Iamsure
-  VERSION = "0.1.0"
+  VERSION = "0.9.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: iamsure
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Mark Torok
@@ -61,17 +61,17 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
-- ".rspec_status"
 - ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - _config.yml
+- bin/console
+- bin/setup
 - iamsure.gemspec
 - lib/iamsure.rb
 - lib/iamsure/initiator.rb
@@ -80,7 +80,10 @@ files:
 homepage: https://torokmark.github.io/iamsure/
 licenses:
 - MIT
-metadata: {}
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://torokmark.github.io/iamsure/
+  source_code_uri: https://torokmark.github.io/iamsure/
 post_install_message: 
 rdoc_options: []
 require_paths:

data/.rspec_status

@@ -1,12 +0,0 @@
-example_id                          | status | run_time        |
------------------------------------ | ------ | --------------- |
-./spec/iamsure_spec.rb[1:1:1]       | passed | 0.00081 seconds |
-./spec/iamsure_spec.rb[1:3:1:1]     | passed | 0.00006 seconds |
-./spec/iamsure_spec.rb[1:3:2:1]     | passed | 0.00006 seconds |
-./spec/iamsure_spec.rb[1:4:1:1]     | passed | 0.00007 seconds |
-./spec/iamsure_spec.rb[1:4:2:1]     | passed | 0.00075 seconds |
-./spec/iamsure_spec.rb[1:4:3:1]     | passed | 0.00027 seconds |
-./spec/iamsure_spec.rb[1:5:1:1]     | passed | 0.00006 seconds |
-./spec/iamsure_spec.rb[1:5:2:1]     | passed | 0.00006 seconds |
-./spec/iamsure_spec.rb[1:5:3:1:1]   | passed | 0.00006 seconds |
-./spec/iamsure_spec.rb[1:5:3:2:1:1] | passed | 0.00007 seconds |

data/LICENSE.txt

@@ -1,21 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2020 TODO: Write your name
-
-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.