argspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e489a3f3ed71350a6e16435cbf19efda2a9bac84
+  data.tar.gz: 2af97d57c3ea415a720d0db32c3ba22d0d7ae7c8
+SHA512:
+  metadata.gz: 3dda7ebf91f61ad7c310950f0788f0941f175019e46e470417c286756c27f1f932db0cda8443817af0bb7b93dc81a371562c83b1fa9e320c7ec1766374b3f47f
+  data.tar.gz: 44e82ea8b0b64566e51540615024e20b38b1f7225ed6eee4d57de71c642f8f6f9d2dfe0a1d0e2cbcef9fae5ee4979c0d0fd90690df4351969c97a1b88fcf37c2

data/.gitignore

@@ -0,0 +1,44 @@
+# Packages #
+############
+*.7z
+*.dmg
+*.gz
+*.iso
+*.jar
+*.rar
+*.tar
+*.zip
+
+# Logs #
+########
+*.log
+
+# Databases #
+#############
+*.sql
+*.sqlite
+
+# OS Files #
+############
+.DS_Store
+.Trashes
+ehthumbs.db
+Icon?
+Thumbs.db
+
+# Vagrant #
+###########
+.vagrant
+
+# Ruby Files #
+##############
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format doc
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,85 @@
+# Argument Specification
+
+Using argspec, you can easily validate that arguments match your required specification.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'argspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install argspec
+
+## Usage
+
+Let's say you have the following ```Person``` class:
+
+```ruby
+class Person
+  attr_reader :name, :gender, :birthdate
+
+  def initialize(name, gender, birthdate)
+    @name = name
+    @gender = gender
+    @birthdate = birthdate
+  end
+end
+```
+
+You'd like to validate those three arguments match the expected type. You might come up with something like this:
+
+```ruby
+class Person
+  attr_reader :name, :gender, :birthdate
+
+  def initialize(name, gender, birthdate)
+    raise ArgumentError, "The name must be a string and must not be nil." if !name.is_a?(String) || name.empty?
+    raise ArgumentError, "The gender must be a symbol." unless gender.is_a?(Symbol)
+    raise ArgumentError, "The birthdate must be a date." unless birthdate.is_a?(Date)
+
+    @name = name
+    @gender = gender
+    @birthdate = birthdate
+  end
+end
+```
+
+That will work fine, but it looks a little messy. Let's use argspec instead:
+
+```ruby
+class Person
+  include ArgumentSpecification::DSL
+
+  attr_reader :name, :gender, :birthdate
+
+  def initialize(name, gender, birthdate)
+    argument(name).should(:be_a, String)
+    argument(gender).should(:be_a, Symbol)
+    argument(birthdate).should(:be_a, Date)
+
+    argument(name).should_not(:be, nil)
+    argument(gender).should_not(:be, nil)
+    argument(birthdate).should_not(:be, nil)
+
+    @name = name
+    @gender = gender
+    @birthdate = birthdate
+  end
+end
+```
+
+That's better. It's now really clear what validations you're performing.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/argspec.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'argspec/constants'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'argspec'
+  spec.version       = ArgumentSpecification::VERSION
+  spec.authors       = ['Nialto Services']
+  spec.email         = ['support@nialtoservices.co.uk']
+
+  spec.summary       = %q{Argument Validation Checks}
+  spec.description   = %q{RSpec style(ish) checks for arguments}
+  spec.homepage      = 'https://rubygems.org/gems/argspec'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',       '~> 1.11'
+  spec.add_development_dependency 'rake',          '~> 10.0'
+  spec.add_development_dependency 'rspec',         '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'argspec'
+
+require 'irb'
+
+IRB.start

data/bin/setup

@@ -0,0 +1,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/lib/argspec/argument.rb

@@ -0,0 +1,130 @@
+module ArgumentSpecification
+  class Argument
+    attr_reader :object
+
+    # Create a new argument
+    #
+    # Arguments:
+    #   object: (?)
+    #
+    # Example:
+    #   >> test = :test
+    #   >> ArgumentSpecification::Argument.new(test)
+    #   => #<Argument:0x00000000000000 @object=:test>
+    #
+    def initialize(object)
+      @object = object
+    end
+
+    # Should
+    #
+    # Arguments:
+    #   matcher: (Symbol) A method name as a symbol (see the matchers.rb file)
+    #   args: (Splat)
+    #
+    # Example:
+    #   >> argument.should(:be, true)
+    #   => nil
+    #
+    # Raises:
+    #   ArgumentError: If the matcher determines the object does not match
+    #
+    def should(matcher, *args)
+      ensure_matcher(matcher)
+
+      return if Matchers.send(matcher, self, *args)
+
+      raise ArgumentError, "'#{prettify_object}' should #{prettify_matcher(matcher)} '#{prettify_args(args)}'"
+    end
+
+    # Should not
+    #
+    # Arguments:
+    #   matcher: (Symbol) A method name as a symbol (see the matchers.rb file)
+    #   args: (Splat)
+    #
+    # Example:
+    #   >> argument.should_not(:be, true)
+    #   => nil
+    #
+    # Raises:
+    #   ArgumentError: If the matcher determines the object does match
+    #
+    def should_not(matcher, *args)
+      ensure_matcher(matcher)
+
+      return if Matchers.send(matcher, self, *args) == false
+
+      raise ArgumentError, "'#{prettify_object}' should not #{prettify_matcher(matcher)} '#{prettify_args(args)}'"
+    end
+
+    private
+    # Ensure a matcher exists
+    #
+    # Arguments:
+    #   matcher: (Symbol)
+    #
+    # Example:
+    #   >> ensure_matcher(:be)
+    #   => nil
+    #
+    # Raises:
+    #   ArgumentError: If the specified matcher does not exist
+    #
+    def ensure_matcher(matcher)
+      return if Matchers.all.include?(matcher)
+
+      raise ArgumentError, "The matcher '#{matcher}' does not exist."
+    end
+
+    # Prettify a matcher
+    #
+    # Arguments:
+    #   matcher: (String)
+    #
+    # Example:
+    #   >> prettify_matcher(:be_a)
+    #   => "be a"
+    #
+    def prettify_matcher(matcher)
+      matcher.to_s.gsub('_', ' ')
+    end
+
+    # Prettify arguments
+    #
+    # Arguments:
+    #   args: (Array)
+    #
+    # Example:
+    #   >> prettify_args([:a])
+    #   => ":a"
+    #
+    def prettify_args(args)
+      pretty_args = args.map do |argument|
+        if argument == nil
+          next 'nil'
+        elsif argument.is_a?(Symbol)
+          next ":#{argument}"
+        else
+          next argument
+        end
+      end
+
+      return 'nil' if pretty_args.empty?
+      return pretty_args.first if pretty_args.count == 1
+
+      pretty_args
+    end
+
+    # Prettify the object
+    #
+    # Example:
+    #   >> # argument.object = :a
+    #   >> prettify_object
+    #   => ":a"
+    #
+    def prettify_object
+      prettify_args([@object])
+    end
+  end
+end

data/lib/argspec/constants.rb

@@ -0,0 +1,3 @@
+module ArgumentSpecification
+  VERSION = '0.1.0'
+end

data/lib/argspec/dsl.rb

@@ -0,0 +1,17 @@
+module ArgumentSpecification
+  module DSL
+    # Get an argument object
+    #
+    # Arguments:
+    #   object: (?)
+    #
+    # Example:
+    #   >> test = :test
+    #   >> argument(test)
+    #   => #<Argument:0x00000000000000 @object=:test>
+    #
+    def argument(object)
+      ArgumentSpecification::Argument.new(object)
+		end
+  end
+end

data/lib/argspec/matchers.rb

@@ -0,0 +1,60 @@
+module ArgumentSpecification
+  module Matchers
+    class << self
+      # Get an array of all available matchers
+      #
+      # Example:
+      #   >> all
+      #   => [:be, ...]
+      #
+			def all
+				[:be, :be_a, :include]
+			end
+
+      # The be matcher
+      #
+      # Arguments:
+      #   argument: (ArgumentSpecification::Argument)
+      #   object: (?)
+      #
+      # Example:
+      #   >> test = 'Test'
+      #   >> argument(test).should_not(:be, nil)
+      #   => nil
+      #
+			def be(argument, object)
+				argument.object == object
+			end
+
+      # The be_a matcher
+      #
+      # Arguments:
+      #   argument: (ArgumentSpecification::Argument)
+      #   object: (?)
+      #
+      # Example:
+      #   >> test = :test
+      #   >> argument(test).should(:be_a, Symbol)
+      #   => nil
+      #
+			def be_a(argument, klass)
+				argument.object.is_a?(klass)
+			end
+
+      # The include matcher
+      #
+      # Arguments:
+      #   argument: (ArgumentSpecification::Argument)
+      #   object: (?)
+      #
+      # Example:
+      #   >> test = [:test]
+      #   >> argument(test).should(:include, :test)
+      #   => nil
+      #
+			def include(argument, object)
+				argument.object.include?(object)
+			end
+		end
+  end
+end

data/lib/argspec.rb

@@ -0,0 +1,20 @@
+module ArgumentSpecification
+  class << self
+    # Require dependencies
+    #
+    # Example:
+    #   >> ArgumentSpecification.require!
+    #   => nil
+    #
+    def require!
+      require 'argspec/constants'
+      require 'argspec/matchers'
+      require 'argspec/argument'
+      require 'argspec/dsl'
+
+      nil
+    end
+  end
+end
+
+ArgumentSpecification.require!

data/spec/argspec_spec.rb

@@ -0,0 +1,5 @@
+describe ArgumentSpecification do
+  it 'has a version number' do
+    expect(ArgumentSpecification::VERSION).not_to be nil
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'argspec'

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: argspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nialto Services
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: RSpec style(ish) checks for arguments
+email:
+- support@nialtoservices.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- argspec.gemspec
+- bin/console
+- bin/setup
+- lib/argspec.rb
+- lib/argspec/argument.rb
+- lib/argspec/constants.rb
+- lib/argspec/dsl.rb
+- lib/argspec/matchers.rb
+- spec/argspec_spec.rb
+- spec/spec_helper.rb
+homepage: https://rubygems.org/gems/argspec
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.6
+signing_key: 
+specification_version: 4
+summary: Argument Validation Checks
+test_files:
+- spec/argspec_spec.rb
+- spec/spec_helper.rb