unboolean 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8df8e469c66e608d5c2f73f260af72aa3e81c211
-  data.tar.gz: a4b70e389958355b3e1b240f99dfd250303feff5
+  metadata.gz: 39636868a0c0e24b9b6bee769408372e8837aa65
+  data.tar.gz: 419bd39b845e45630702fe65f8e740ec6b6bfe78
 SHA512:
-  metadata.gz: 100d94aec46eb5e3ed573a54b25d45e63cd167694a8ac22e90d99d6579f0358cc0215059a52d617d497720744316f36a58f5191e6e4cc5dd894a5afcb6476703
-  data.tar.gz: bdad018835d7ff7d15d6f6e3c5e423c95b9a0b3a25cca3d08dd1d091e7f84fb094b0bfb195d8f2d9862bec99311ad9b33f895e0fe5acc0c79248b27763f68462
+  metadata.gz: 184b4498979b9384180518e6105627973b4a8895b934fa991ee28786d0482c89d5def81c35b5181ead591362e0d58270f48e353e64e2be55c54f46f76921342d
+  data.tar.gz: b9297aba442e75b50885ae7a716cdd98afab62e58dbb52733c70915f890f22ec83cb7c076cc6e232b6928f17ccb0bb7ff435e184a37c77f06cf0ed2fbf01f5db

data/CHANGELOG.md

@@ -0,0 +1,12 @@
+== 0.0.2
+
+* Better inspect value for `Unboolean::Maybe` instance.
+* Fix `true` and `false` methods: `:&`, `:|`, `:^`, `:!` (covered with RSpec)
+* Structured code has a bit more logic. Maybe
+* 100%-coverage of code
+
+== 0.0.1
+
+* Namespace `Unboolean`
+* `Unboolean::Maybe` class that represents companion for `TrueClass` and `FalseClass` from Ruby core
+* Kernel extension to provide convenient method to use `maybe` function in code

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in unboolean.gemspec
 gemspec
+
+group :documentation do
+  gem 'redcarpet', platforms: :ruby
+  gem 'kramdown', platforms: :jruby
+end

data/README.md

@@ -1,37 +1,66 @@
 # Unboolean
 
+[![Build Status](https://travis-ci.org/alsemyonov/unboolean.png)](https://travis-ci.org/alsemyonov/unboolean)
+[![Dependency Status](https://gemnasium.com/alsemyonov/unboolean.png)](https://gemnasium.com/alsemyonov/unboolean)
+[![Code Climate](https://codeclimate.com/github/alsemyonov/unboolean.png)](https://codeclimate.com/github/alsemyonov/unboolean)
+[![Coverage Status](https://coveralls.io/repos/alsemyonov/unboolean/badge.png)](https://coveralls.io/r/alsemyonov/unboolean)
+[![Roadmap and Changelog](https://roadchange.com/alsemyonov/unboolean/badge.png)](https://roadchange.com/alsemyonov/unboolean)
+
 Boolean is too boring. Let’s add `maybe` to `true` and `false`.
 
+## Project links
+
+* [Source](https://github.com/alsemyonov/unboolean)
+* [Issues](https://github.com/alsemyonov/unboolean/issues)
+* Documentation: [Stable](https://rubydoc.info/gems/unboolean) and [Edge](https://rubydoc.info/github/alsemyonov/unboolean)
+* [Wiki](https://github.com/alsemyonov/unboolean/wiki)
+
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'unboolean'
+```ruby
+gem 'unboolean'
+```
 
 And then execute:
 
-    $ bundle
+```bash
+$ bundle
+```
 
 Or install it yourself as:
 
-    $ gem install unboolean
+```bash
+$ gem install unboolean
+```
 
 ## Usage
 
 ```ruby
 maybe == maybe # => maybe
+maybe == true # => maybe
+maybe == false # => maybe
+true == maybe # => maybe
+false == true # => maybe
 
 maybe & true # => maybe
 maybe & false # => false
 maybe & maybe # => maybe
+true & maybe # => maybe
+false & maybe # => false
 
 maybe | true # => true
 maybe | false # => maybe
 maybe | maybe # => maybe
+true | maybe # => true
+false | maybe # => maybe
 
 maybe ^ true # => maybe
 maybe ^ false # => maybe
 maybe ^ maybe # => maybe # Do you think it may not be? No! Everything may be.
+true ^ maybe # => maybe
+false ^ maybe # => maybe
 
 !maybe # => maybe # Yes, it is still may be.
 ```
@@ -43,3 +72,7 @@ maybe ^ maybe # => maybe # Do you think it may not be? No! Everything may be.
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create new Pull Request
+
+## Copyright
+
+© [Alexander Semyonov](mailto:al@semyonov.us), 2013, MIT License.

data/ROADMAP.md

@@ -0,0 +1,14 @@
+== 0.0.5
+
+* `Unboolean::Probably` representing `maybe` with less standard deviation
+* Kernel extension to provide convenient method `probably` and `hardly`
+
+== 0.0.4
+
+* `Unboolean::Unlikely` and `Unboolean::Hardly` representing more unlikely values than `maybe`
+* Kernel extension to provide convenient methods `unlikely` and `hardly`
+
+== 0.0.3
+
+* `Unboolean::Certainly` and `Unboolean::Likely` representing more likely values than `maybe`
+* Kernel extension to provide convenient methods `certainly` and `likely`

data/Rakefile

@@ -1,6 +1,21 @@
 require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new(:doc)
+rescue LoadError
+  task :doc do
+    abort "YARD is not available. In order to run yardoc, you must: gem install yard"
+  end
+end
 
-task :default => :spec
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+rescue LoadError
+  task :spec do
+    abort "RSpec is not available. In order to run specs, you must: gem install rspec"
+  end
+end
+
+task default: :spec

data/lib/unboolean/core_ext.rb

@@ -1,8 +1,3 @@
-require 'unboolean'
-require 'unboolean/maybe'
-
-module Kernel
-  def maybe
-    @__unboolean_maybe ||= Unboolean::Maybe.new
-  end
-end
+require 'unboolean/core_ext/kernel'
+require 'unboolean/core_ext/true_class'
+require 'unboolean/core_ext/false_class'

data/lib/unboolean/core_ext/false_class.rb

@@ -0,0 +1,16 @@
+require 'unboolean'
+require 'unboolean/maybe'
+
+class FalseClass
+  def |(other)
+    other.is_a?(Unboolean::Maybe) ? other | self : !!(other)
+  end
+
+  def ^(other)
+    other.is_a?(Unboolean::Maybe) ? other ^ self : (!other).is_a?(FalseClass)
+  end
+
+  def ==(other)
+    other.is_a?(Unboolean::Maybe) ? other == self : (!!other).is_a?(FalseClass)
+  end
+end

data/lib/unboolean/core_ext/kernel.rb

@@ -0,0 +1,8 @@
+require 'unboolean'
+require 'unboolean/maybe'
+
+module Kernel
+  def maybe
+    @__unboolean_maybe ||= Unboolean::Maybe.new
+  end
+end

data/lib/unboolean/core_ext/true_class.rb

@@ -0,0 +1,16 @@
+require 'unboolean'
+require 'unboolean/maybe'
+
+class TrueClass
+  def &(other)
+    other.is_a?(Unboolean::Maybe) ? other & self : !!(other)
+  end
+
+  def ^(other)
+    other.is_a?(Unboolean::Maybe) ? other ^ self : (!other).is_a?(TrueClass)
+  end
+
+  def ==(other)
+    other.is_a?(Unboolean::Maybe) ? other == self : (!!other).is_a?(TrueClass)
+  end
+end

data/lib/unboolean/maybe.rb

@@ -3,6 +3,7 @@ require 'singleton'
 
 module Unboolean
   class Maybe
+    # May be singleton?
     def self.new
       @__unboolean_maybe_instance ||= super
     end
@@ -26,5 +27,9 @@ module Unboolean
     def ==(*)
       Maybe.new
     end
+
+    def inspect
+      'maybe'
+    end
   end
 end

data/lib/unboolean/version.rb

@@ -1,3 +1,3 @@
 module Unboolean
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/spec/spec_helper.rb

@@ -1,2 +1,11 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start
+
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'unboolean'

data/spec/unboolean/core_ext/false_class_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe false do
+  subject { false }
+
+  specify('#=> false') { expect(subject).to eql(false) }
+
+  context '!' do
+    specify('#=> true') { expect(!subject).to eql(true) }
+  end
+
+  context '==' do
+    specify('true #=> false') { expect(subject == true).to eql(false) }
+    specify('false #=> true') { expect(subject == false).to eql(true) }
+    specify('maybe #=> maybe') { expect(subject == maybe).to eql(maybe) }
+  end
+
+  context '&' do
+    specify('true #=> false') { expect(subject & true).to eql(false) }
+    specify('false #=> false') { expect(subject & false).to eql(false) }
+    specify('maybe #=> false') { expect(subject & maybe).to eql(false) }
+  end
+
+  context '|' do
+    specify('true #=> true') { expect(subject | true).to eql(true) }
+    specify('false #=> false') { expect(subject | false).to eql(false) }
+    specify('maybe #=> maybe') { expect(subject | maybe).to eql(maybe) }
+  end
+
+  context '^' do
+    specify('true #=> true') { expect(subject ^ true).to eql(true) }
+    specify('false #=> false') { expect(subject ^ false).to eql(false) }
+    specify('maybe #=> maybe') { expect(subject ^ maybe).to eql(maybe) }
+  end
+end

data/spec/unboolean/core_ext/true_class_spec.rb

@@ -0,0 +1,35 @@
+require 'spec_helper'
+
+describe true do
+  subject { true }
+
+  specify('#=> true') { expect(subject).to eql(true) }
+
+  context '!' do
+    specify('#=> false') { expect(!subject).to eql(false) }
+  end
+
+  context '==' do
+    specify('true #=> true') { expect(subject == true).to eql(true) }
+    specify('false #=> false') { expect(subject == false).to eql(false) }
+    specify('maybe #=> maybe') { expect(subject == maybe).to eql(maybe) }
+  end
+
+  context '&' do
+    specify('true #=> true') { expect(subject & true).to eql(true) }
+    specify('false #=> false') { expect(subject & false).to eql(false) }
+    specify('maybe #=> maybe') { expect(subject & maybe).to eql(maybe) }
+  end
+
+  context '|' do
+    specify('true #=> true') { expect(subject | true).to eql(true) }
+    specify('false #=> true') { expect(subject | false).to eql(true) }
+    specify('maybe #=> true') { expect(subject | maybe).to eql(true) }
+  end
+
+  context '^' do
+    specify('true #=> false') { expect(subject ^ true).to eql(false) }
+    specify('false #=> true') { expect(subject ^ false).to eql(true) }
+    specify('maybe #=> maybe') { expect(subject ^ maybe).to eql(maybe) }
+  end
+end

data/spec/unboolean/maybe_spec.rb

@@ -1,24 +1,37 @@
 require 'spec_helper'
 
-describe Unboolean::Maybe do
-  subject(:maybe) { described_class.new }
+describe 'maybe' do
+  subject(:maybe) { Unboolean::Maybe.new }
 
-  specify('maybe MAY BE maybe') { expect(maybe).to eql(maybe) }
-  specify('NOT maybe may be maybe') { expect(!maybe).to eql(maybe) }
+  its(:inspect) { should == 'maybe' }
 
-  specify('maybe MAY BE equal to maybe') { expect(maybe == maybe).to eql(maybe) }
-  specify('maybe MAY BE equal to true') { expect(maybe == true).to eql(maybe) }
-  specify('maybe MAY BE equal to false') { expect(maybe == false).to eql(maybe) }
+  specify('#=> maybe') { expect(subject).to eql(maybe) }
 
-  specify('maybe AND true may be maybe') { expect(maybe & true).to eql(maybe) }
-  specify('maybe AND false may be false') { expect(maybe & false).to eql(false) }
-  specify('maybe AND maybe may be maybe') { expect(maybe & maybe).to eql(maybe) }
+  context '!' do
+    specify('#=> maybe') { expect(!subject).to eql(maybe) }
+  end
 
-  specify('maybe OR true should be true') { expect(maybe | true).to eql(true) }
-  specify('maybe OR false may be maybe') { expect(maybe | false).to eql(maybe) }
-  specify('maybe OR maybe may be maybe') { expect(maybe | maybe).to eql(maybe) }
+  context '==' do
+    specify('true #=> maybe') { expect(subject == true).to eql(maybe) }
+    specify('false #=> maybe') { expect(subject == false).to eql(maybe) }
+    specify('maybe #=> maybe') { expect(subject == maybe).to eql(maybe) }
+  end
 
-  specify('maybe XOR true may be maybe') { expect(maybe ^ true).to eql(maybe) }
-  specify('maybe XOR false may be maybe') { expect(maybe ^ false).to eql(maybe) }
-  specify('maybe XOR maybe may be maybe') { expect(maybe ^ maybe).to eql(maybe) }
+  context '&' do
+    specify('true #=> maybe') { expect(subject & true).to eql(maybe) }
+    specify('false #=> false') { expect(subject & false).to eql(false) }
+    specify('maybe #=> maybe') { expect(subject & maybe).to eql(maybe) }
+  end
+
+  context '|' do
+    specify('true #=> true') { expect(subject | true).to eql(true) }
+    specify('false #=> maybe') { expect(subject | false).to eql(maybe) }
+    specify('maybe #=> maybe') { expect(subject | maybe).to eql(maybe) }
+  end
+
+  context '^' do
+    specify('true #=> maybe') { expect(subject ^ true).to eql(maybe) }
+    specify('false #=> maybe') { expect(subject ^ false).to eql(maybe) }
+    specify('maybe #=> maybe') { expect(subject ^ maybe).to eql(maybe) }
+  end
 end

data/unboolean.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = %w(al@semyonov.us)
   spec.description   = %q{Boolean is too boring. Let’s add Maybe value.}
   spec.summary       = %q{True, false, or Maybe?}
-  spec.homepage      = ''
+  spec.homepage      = 'https://github.com/alsemyonov/unboolean'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
@@ -21,4 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+  spec.add_development_dependency 'yard'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: unboolean
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Alexander Semyonov
@@ -52,6 +52,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Boolean is too boring. Let’s add Maybe value.
 email:
 - al@semyonov.us
@@ -62,19 +104,26 @@ files:
 - .gitignore
 - .rspec
 - .travis.yml
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
+- ROADMAP.md
 - Rakefile
 - lib/unboolean.rb
 - lib/unboolean/core_ext.rb
+- lib/unboolean/core_ext/false_class.rb
+- lib/unboolean/core_ext/kernel.rb
+- lib/unboolean/core_ext/true_class.rb
 - lib/unboolean/maybe.rb
 - lib/unboolean/version.rb
 - spec/spec_helper.rb
+- spec/unboolean/core_ext/false_class_spec.rb
+- spec/unboolean/core_ext/true_class_spec.rb
 - spec/unboolean/maybe_spec.rb
 - spec/unboolean_spec.rb
 - unboolean.gemspec
-homepage: ''
+homepage: https://github.com/alsemyonov/unboolean
 licenses:
 - MIT
 metadata: {}
@@ -100,5 +149,8 @@ specification_version: 4
 summary: True, false, or Maybe?
 test_files:
 - spec/spec_helper.rb
+- spec/unboolean/core_ext/false_class_spec.rb
+- spec/unboolean/core_ext/true_class_spec.rb
 - spec/unboolean/maybe_spec.rb
 - spec/unboolean_spec.rb
+has_rdoc: