yard-bench 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: f4b741f7ac917188402ae134a53b8ee9f65a4409
+  data.tar.gz: a6db99b9f15facdd66aabd7936176681a0259caa
+!binary "U0hBNTEy":
+  metadata.gz: 4c3359d6aaf319af83c779c4998aa438f5ed846b69335a6b6a1082e3eb19450f30cf9f6e2b237cb11d3b004d44f77facc265132ffc54775b2c63e02dc228a894
+  data.tar.gz: 22637cfe552421e8bf4d11bb1fd1817a84b27fe7ad2568eb1b6dfc7d589680322935b8e4e7ad1cba61da41b857454afc3330388db48b87b3dd16d94fb8d1a3af

data/.document

@@ -0,0 +1,11 @@
+# .document is used by rdoc and yard to know how to generate documentation 
+# for example, it can be used to control how rdoc gets built when you do `gem install foo`
+
+README.rdoc
+lib/**/*.rb
+bin/*
+
+# Files below this - are treated as 'extra files', and aren't parsed for ruby code
+- 
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yard-bench.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+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/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Alexei Matyushkin
+
+MIT License
+
+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,38 @@
+# YARD::Bench
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'yard-bench'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yard-bench
+
+## Usage
+
+Put the following code anywhere within your class:
+
+    benchmark :func1, :func2
+    
+or even:
+
+    class String
+       ⌚ :⋅
+
+and the benchmarks for the chosen functions will be included in yardoc.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+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

data/Rakefile

@@ -0,0 +1,35 @@
+require 'bundler/setup'
+
+Rake::TaskManager.record_task_metadata = true
+
+require 'bueller'
+Bueller::Tasks.new
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:examples) do |examples|
+  examples.rspec_opts = '-Ispec'
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.rspec_opts = '-Ispec'
+  spec.rcov = true
+end
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:features) do |t|
+  t.cucumber_opts = "--format Cucumber::Formatter::ColorCommentFormatter"
+end
+
+task :default => :examples
+
+require 'yard'
+YARD::Rake::YardocTask.new do |t|
+  t.files   = ['lib/**/*.rb', 'features/**/*.feature', 'features/**/*.rb', 'examples/**/*.rb']
+  t.options = ['-e./lib/yard-bench.rb', '--no-private']
+end
+
+task :list do
+  Rake.application.tasks.each do |task|
+    print task.name() + ' #' + task.comment.to_s() + "\n"
+  end
+end

data/config/cucumber.yml

@@ -0,0 +1,6 @@
+# config/cucumber.yml
+##YAML Template
+---
+default: --profile yard
+yard: --format Cucumber::Formatter::ColorCommentFormatter
+standard: --format pretty

data/examples/example_benchmark.rb

@@ -0,0 +1,34 @@
+# encoding: utf-8
+
+require_relative '../lib/dsl/bm_dsl'
+
+# Example module to test benchmarking functionality.
+module BmExamples
+  # Example class to test benchmarking functionality.
+  class BmExample
+    benchmark :do_it
+    ⌚ :do_other
+    
+    # The value
+    attr_reader :value
+    # Constructor.
+    # @param value [Fixnum] the value to add to 10 within {#value} initializer.
+    # @param addval [Fixnum] another value to add to 10 within {#value} initializer.
+    # @param attrs [Hash] additional parameters (ignored.)
+    def initialize value, addval, *attrs
+      @value = 10 + value + addval
+    end
+    # Multiplies {#value} by parameter given.
+    # @param deg [Fixnum]
+    # @return [Fixnum] {#value} multiplied by deg.
+    def do_it deg
+      @value * deg
+    end
+    # Produces a power of the parameter given.
+    # @param base [Fixnum]
+    # @return [Fixnum] {#value} in a power of base
+    def do_other base = 2
+      @value ** base
+    end
+  end
+end

data/features/bm_dsl.feature

@@ -0,0 +1,36 @@
+Feature: The DSL for benchmarking within YARD documentation
+  In order to provide benchmarking within YARDoc
+  A developer uses DSL
+
+# -----------------------------------------------------------
+# --------------------   Callers   --------------------------
+# -----------------------------------------------------------
+
+  Scenario: ☎ is the method to create new instance of a class with suggested params if needed
+    Given I have a class with contructor requiring parameters
+    When I call a ☎ method on it
+    Then I have an instance of the class
+
+  Scenario: ☏ is the method to be called on an instance of the class with suggested params if needed
+    Given I have an instance method of the class requiring parameters
+    When I call a ☏ method for it
+    Then I have params suggested and the method called
+
+# -----------------------------------------------------------
+# --------------------   Measures   -------------------------
+# -----------------------------------------------------------
+
+  Scenario: The benchmarks set are to be processed with call to ::Kernel::⌛ method
+    Given I marked some methods as benchmarkable
+    When I call a ⌛ method
+    Then I yield all the benchmarks
+
+  Scenario: The benchmarks may be set with wildcards
+    Given I marked all methods of a class as benchmarkable via `:⋅`
+    When I call a ⌛ method
+    Then I yield all the benchmarks
+    
+  Scenario: The only benchmark is to be returned properly for the class’ method
+    Given I marked all methods of a class as benchmarkable via `:⋅`
+    When I call a get method with `BmTests::BmTester`, `do_it` parameters
+    Then I yield the benchmarks for `do_it` method

data/features/monkeypatches.feature

@@ -0,0 +1,82 @@
+Feature: Applying shorthands and some new methods to standard library
+  In order to make the coding a really delightful process
+  A developer uses new aliases/shorthands/functions and enjoys
+
+# -----------------------------------------------------------
+# --------------------   Kernel   ---------------------------
+# -----------------------------------------------------------
+
+  Scenario: λ is the alias for lambda
+    Given I define lambda with newly introduced λ alias
+    When I call a codeblock defined with “λ”
+    Then the code is being executed and returns proper value (squared param)
+    
+  Scenario: λ is the proper lambda (parameter count aware) alias for lambda
+    Given I define lambda with newly introduced λ alias
+    When I call a codeblock defined with “λ” with wrong amount of arguments
+    Then I got ArgumentError as the result
+    
+  Scenario: Λ is the alias for proc
+    Given I define proc with newly introduced Λ alias
+    When I call a codeblock defined with “Λ”
+    Then the code is being executed and returns proper value (squared param)
+    
+  Scenario: Λ is the proc not lambda (parameter count unaware) alias for proc
+    Given I define proc with newly introduced Λ alias
+    When I call a codeblock defined with “Λ” with wrong amount of arguments
+    Then the code is being executed and returns proper value (squared param)
+
+# -----------------------------------------------------------
+
+  Scenario: Random values for the supported classes should be produced
+    Given I define classset as default (String, Fixnum, Array, Hash)
+    When I ask for a random value on a classset
+    Then the random value should have one of the classes given
+    
+# -----------------------------------------------------------
+# --------------------   Randoms   --------------------------
+# -----------------------------------------------------------
+  
+  Scenario: Random value for the String class should be produced
+    Given I am `using YARD::MonkeyPatches`
+    When I call random of a size 1024 on a String instance
+    Then the random value should be generated of type String and have length of 1024
+  
+  Scenario: Random value for the Fixnum class should be produced
+    Given I am `using YARD::MonkeyPatches`
+    When I call random on a Fixnum instance 1024
+    Then the random value should be generated of type Fixnum and be less than 1024
+  
+  Scenario: Random value for the Array class should be produced
+    Given I am `using YARD::MonkeyPatches`
+    When I call random of a size 1024 on an Array instance
+    Then the random value should be generated of type Array and have length of 1024
+  
+  Scenario: Random value for the Hash class should be produced
+    Given I am `using YARD::MonkeyPatches`
+    When I call random of a size 1024 on a Hash instance
+    Then the random value should be generated of type Hash and have length of 1024
+  
+# -----------------------------------------------------------
+# --------------------   Singletons   -----------------------
+# -----------------------------------------------------------
+  
+  Scenario: Random value for the String class should be produced by call to String.∀
+    Given I am `using YARD::MonkeyPatches`
+    When I call ∀ on a String class
+    Then the random value should be generated of type String and have default length of 32
+  
+  Scenario: Random value for the Fixnum class should be produced by call to Fixnum.∀
+    Given I am `using YARD::MonkeyPatches`
+    When I call ∀ on a Fixnum class
+    Then the random value should be generated of type Fixnum and be not greater than 1024
+
+  Scenario: Random value for the Array class should be produced by call to Array.∀
+    Given I am `using YARD::MonkeyPatches`
+    When I call ∀ on an Array class with size parameter 64
+    Then the random value should be generated of type Array and have size of the parameter
+
+  Scenario: Random value for the Hash class should be produced by call to Hash.∀
+    Given I am `using YARD::MonkeyPatches`
+    When I call ∀ on a Hash class with size parameter 64
+    Then the random value should be generated of type Hash and have size of the parameter

data/features/step_definitions/cukes_bm_dsl.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require 'yard-bench'
+
+using YARD::MonkeyPatches
+using YARD::Bench
+
+# @private
+module BmTests
+  class BmTester
+    attr_reader :value
+    def initialize value, addval, *attrs
+      @value = 10 + value + addval
+    end
+    def do_it deg
+      @value * deg
+    end
+    def do_other base = 2
+      base * @value
+    end
+  end
+end
+
+# -----------------------------------------------------------
+# --------------------   Callers   --------------------------
+# -----------------------------------------------------------
+
+Given(/^I have a class with contructor requiring parameters$/) do
+  # BmTests::BmTester above
+end
+
+When(/^I call a ☎ method on it$/) do
+  @inst = BmTests::BmTester.☎
+end
+
+Then(/^I have an instance of the class$/) do
+  BmTests::BmTester === @inst
+end
+
+Given(/^I have an instance method of the class requiring parameters$/) do
+  # BmTests::BmTester.do_it above
+end
+
+When(/^I call a ☏ method for it$/) do
+  @res = BmTests::BmTester.☏ :do_it
+end
+
+Then(/^I have params suggested and the method called$/) do
+  puts @res
+end
+
+# -----------------------------------------------------------
+# --------------------   Measures   -------------------------
+# -----------------------------------------------------------
+
+Given(/^I marked some methods as benchmarkable$/) do
+  class String
+    benchmark :capitalize
+  end
+end
+
+Given(/^I marked all methods of a class as benchmarkable via `:⋅`$/) do
+  class BmTests::BmTester
+    benchmark :⋅
+  end
+end
+
+When(/^I call a ⌛ method$/) do
+  puts YARD::Bench::Marks.⌛
+end
+
+Then(/^I yield all the benchmarks$/) do
+  # pending # express the regexp above with the code you wish you had
+end
+
+When(/^I call a get method with `BmTests::BmTester`, `do_it` parameters$/) do
+  puts YARD::Bench::Marks.get 'BmTests::BmTester', 'do_it'
+end
+
+Then(/^I yield the benchmarks for `do_it` method$/) do
+  # pending # express the regexp above with the code you wish you had
+end
+

data/features/step_definitions/cukes_monkeypatches.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'yard-bench'
+
+using YARD::MonkeyPatches
+
+# -----------------------------------------------------------
+# --------------------   Kernel   ---------------------------
+# -----------------------------------------------------------
+
+Given(/^I define lambda with newly introduced λ alias$/) do
+  @cb = λ { |a| a*2 }
+  @orig = lambda { |a| a*2 }
+end
+
+Given(/^I define proc with newly introduced Λ alias$/) do
+  @cb = Λ { |a| a*2 }
+  @orig = proc { |a| a*2 }
+end
+
+When(/^I call a codeblock defined with “(.*?)”$/) do |arg|
+  @result = @cb.call arg
+  @expected = @orig.call arg
+end
+
+Then(/^the code is being executed and returns proper value \(squared param\)$/) do
+  @expected == @result
+end
+
+When(/^I call a codeblock defined with “(.*?)” with wrong amount of arguments$/) do |arg|
+  @result = (@cb.call(arg, arg, arg) rescue $!)
+end
+
+Then(/^I got ArgumentError as the result$/) do
+  ArgumentError === @result
+end
+
+# -----------------------------------------------------------
+
+Given(/^I define classset as default \((.*)\)$/) do |arg|
+  @c = instance_eval("[#{arg}]")
+end
+
+When(/^I ask for a random value on a classset$/) do
+  @r = random
+end
+
+Then(/^the random value should have one of the classes given$/) do
+  10.times { @c.include? @r.class }
+end
+
+# -----------------------------------------------------------
+# --------------------   Randoms   --------------------------
+# -----------------------------------------------------------
+
+Given(/^I am `using YARD::MonkeyPatches`$/) do
+  # already using in the top of file
+end
+
+When(/^I call random of a size (\d+) on a String instance$/) do |sz|
+  @i = "".∀ :size => sz.to_i
+end
+
+Then(/^the random value should be generated of type String and have length of (\d*)$/) do |sz|
+  String === @i && sz.to_i == @i.length
+  puts "Generated String: “#{@i}”"
+end
+
+When(/^I call random on a Fixnum instance (\d+)$/) do |mx|
+  @i = mx.to_i.∀
+end
+
+Then(/^the random value should be generated of type Fixnum and be less than (\d+)$/) do |mx|
+  Fixnum === @i && @i < mx.to_i
+  puts "Generated Fixnum: “#{@i}”"
+end
+
+When(/^I call random of a size (\d+) on an Array instance$/) do |sz|
+  @i = [].∀ :size => sz.to_i
+end
+
+Then(/^the random value should be generated of type Array and have length of (\d+)$/) do |mx|
+  Array === @i && mx.to_i == @i.size
+  puts "Generated Array (1st element): “#{@i[0]}”"
+end
+
+When(/^I call random of a size (\d+) on a Hash instance$/) do |sz|
+  @i = {}.∀ :size => sz.to_i
+end
+
+Then(/^the random value should be generated of type Hash and have length of (\d+)$/) do |mx|
+  Hash === @i && mx.to_i == @i.size
+  puts "Generated Hash (1st element): “#{@i.first}”"
+end
+
+# -----------------------------------------------------------
+# --------------------   Singletons   -----------------------
+# -----------------------------------------------------------
+  
+When(/^I call ∀ on a String class$/) do
+  @is = String.∀
+end
+
+Then(/^the random value should be generated of type String and have default length of (\d+)$/) do |sz|
+  String === @is && sz.to_i == @is.length
+  puts "Generated String: “#{@is}”"
+end
+
+When(/^I call ∀ on a Fixnum class$/) do
+  @if = Fixnum.∀
+end
+
+Then(/^the random value should be generated of type Fixnum and be not greater than (\d+)$/) do |maxval|
+  Fixnum === @if && @if < maxval.to_i
+  puts "Generated Fixnum: “#{@if}”"
+end
+
+When(/^I call ∀ on an Array class with size parameter (\d+)$/) do |sz|
+  @sz = sz.to_i
+  @ia = Array.∀ :size => @sz
+end
+
+Then(/^the random value should be generated of type Array and have size of the parameter$/) do
+  Array === @ia && @ia.size == @sz
+  puts "Generated Array (1st element): “#{@ia[0]}”"
+end
+
+When(/^I call ∀ on a Hash class with size parameter (\d+)$/) do |sz|
+  @sz = sz.to_i
+  @ih = Hash.∀ :size => @sz
+end
+
+Then(/^the random value should be generated of type Hash and have size of the parameter$/) do
+  Hash === @ih && @ih.size == @sz
+  puts "Generated Hash (1st element): “#{@ih.first}”"
+end

data/features/support/color-comment-formatter.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+# features/support/color-comment-formatter.rb
+
+require 'rubygems'
+require 'cucumber/formatter/pretty'
+
+module Cucumber
+  module Formatter
+    class ColorCommentFormatter < Cucumber::Formatter::Pretty
+      def initialize(step_mother, io, options)
+        super(step_mother, io, options)
+      end
+  
+      def comment_line comment_line
+        @io.puts(format_string(comment_line, :comment).indent(@indent))
+        @io.flush
+      end
+    end
+  end
+end

data/features/support/env.rb

@@ -0,0 +1,5 @@
+# encoding: utf-8
+
+require 'bundler/setup'
+require 'yard-bench'
+require 'rspec/expectations'