warder 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5722366067d6e558ab7157e80c1694aa6e0e25d9
-  data.tar.gz: be7feca3cb5590c036cc40fd87999d5c7a830c88
+  metadata.gz: 08b7e90e5910c5193dada4ec370cb0bf223bb9cc
+  data.tar.gz: 09733b69ddd83cb5581aa008f879fe3d2d091a18
 SHA512:
-  metadata.gz: c13f582753760689cd4a6fceb3d01f41b755cd419da0a494aab93ba228eeb830cf604aae71b06743b90daebc0abb1e5fe3c598c7e19196b016902197e6bcb65a
-  data.tar.gz: 3f92ce99152a65e26302c08eab72387383311370cc980d19a01d610c49240918101f26c7ccbed4544fc4fc93dce809ddb448baf6befd7f0f3b5b15ff06fa9763
+  metadata.gz: e602f21426ba7133738b82db52db9d20aeed3cceb2cd68d1ba5a2921be9cec2a0e96a20db2a1e8aaf56b9b7fa70b1307bd24a68cbfa797f2bc08cbe726909bbd
+  data.tar.gz: 2cc2b364e1172bf40ff8e031bd1a8f176e4cd78d31bd32761bda300236b3d0f55646ca844867fe4f8176a22268c83c2dc06bb822707242322bd7d7d0c71cbbf7

data/Rakefile

@@ -1,5 +1,6 @@
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 
 namespace :spec do
   desc 'Run specs that should pass'
@@ -10,17 +11,43 @@ namespace :spec do
 
   desc 'Run specs that are being worked on'
   RSpec::Core::RakeTask.new(:wip) do |t|
-    t.rspec_opts = '--tag wip'
+    t.rspec_opts = '--color --tag wip'
     t.pattern = './spec/**/*_spec.rb'
   end
 
   desc 'Run all specs'
   RSpec::Core::RakeTask.new(:all) do |t|
+    t.rspec_opts = '--color'
     t.pattern = './spec/**/*_spec.rb'
   end
 end
 
+namespace :cucumber do
+  desc 'Run features that should pass'
+  Cucumber::Rake::Task.new(:ok) do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'ok'
+  end
+
+  desc 'Run features that are being worked on'
+  Cucumber::Rake::Task.new(:wip) do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'wip'
+  end
+
+  desc 'Run all features'
+  Cucumber::Rake::Task.new(:all) do |t|
+    t.fork = true # You may get faster startup if you set this to false
+    t.profile = 'default'
+  end
+end
+
+desc 'Alias for cucumber:ok'
+task :cucumber => 'cucumber:ok'
+
 desc 'Alias for spec:ok'
 task :spec => 'spec:ok'
 
-task :default => 'spec'
+task :wip => %w(spec:wip cucumber:wip)
+task :all => %w(spec:all cucumber:all)
+task :default => %w(spec cucumber)

data/bin/warder

@@ -1,5 +1,26 @@
 #!/usr/bin/env ruby
 
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+
+require 'optparse'
 require 'warder'
 
-Warder::Runner.new.run!
+options = {}
+OptionParser.new do |opts|
+  desc = 'Run style guide validation'
+  opts.on('-s', '--[no-]style-guide', desc) do |value|
+    options[:style_guide] = value
+  end
+
+  desc = 'Run magick numbers validation'
+  opts.on('-n', '--[no-]magick-numbers', desc) do |value|
+    options[:magick_numbers] = value
+  end
+
+  desc = 'Run code duplication validation'
+  opts.on('-d', '--[no-]code-duplications', desc) do |value|
+    options[:code_duplications] = value
+  end
+end.parse!
+
+Warder::CLI.new(options).perform

data/cucumber.yml

@@ -0,0 +1,4 @@
+<% std_opts = "--format 'pretty'" %>
+default: <%= std_opts %> --strict features
+ok: <%= std_opts %> --no-color --strict --tags ~@wip features
+wip: <%= std_opts %> --tags @wip:1 --wip features

data/features/detects_code_duplications.feature

@@ -0,0 +1,22 @@
+Feature: detects code duplications
+  In order to find code duplications
+  As a ruby developer
+  I want to run warder with --code-duplications option
+
+  Scenario: run warder with enabled code duplications option
+    Given I have valid file in directory
+    When I run `warder --code-duplications`
+    Then warder detects code duplications
+    Then the exit status should be 0
+
+  Scenario: run warder with enabled code duplications option on invalid file
+    Given I have invalid_code_duplications file in directory
+    When I run `warder --code-duplications`
+    Then warder detects code duplications
+    Then the exit status should be 1
+
+  Scenario: run warder with disabled code duplications option on invalid file
+    Given I have invalid_magick_numbers file in directory
+    When I run `warder --no-code-duplications`
+    Then warder does nothing
+    Then the exit status should be 0

data/features/detects_magick_numbers.feature

@@ -0,0 +1,22 @@
+Feature: detects magick numbers
+  In order to find magick numbers
+  As a ruby developer
+  I want to run warder with --magick-numbers option
+
+  Scenario: run warder with enabled magick numbers option
+    Given I have valid file in directory
+    When I run `warder --magick-numbers`
+    Then warder detects magick numbers
+    Then the exit status should be 0
+
+  Scenario: run warder with enabled magick numbers option on invalid file
+    Given I have invalid_magick_numbers file in directory
+    When I run `warder --magick-numbers`
+    Then warder detects magick numbers
+    Then the exit status should be 1
+
+  Scenario: run warder with disabled style guide option on invalid file
+    Given I have invalid_magick_numbers file in directory
+    When I run `warder --no-magick-numbers`
+    Then warder does nothing
+    Then the exit status should be 0

data/features/run.feature

@@ -0,0 +1,9 @@
+Feature: run warder
+  In order to check project codebase
+  I want to run warder
+
+  Scenario: run warder with no options
+    Given I have valid file in directory
+    When I run `warder`
+    Then warder does nothing
+    And the exit status should be 0

data/features/step_definitions/detects_code_duplications_steps.rb

@@ -0,0 +1,8 @@
+Then(/^warder detects code duplications$/) do
+  executing_flay_output = "executing 'flay -d -m 15 .'"
+  success_flay_output = `flay -d spec/fixtures/#{@filename}`
+  step "the output should contain \"#{executing_flay_output}\""
+  success_flay_output.split("\n").each do |string|
+    step "the output should contain \"#{string.sub('spec/fixtures/', './')}\""
+  end
+end

data/features/step_definitions/detects_magick_numbers_steps.rb

@@ -0,0 +1,8 @@
+Then(/^warder detects magick numbers$/) do
+  executing_mago_output = "executing 'mago'"
+  success_mago_output = `mago spec/fixtures/#{@filename}`
+  step "the output should contain \"#{executing_mago_output}\""
+  success_mago_output.split("\n").each do |string|
+    step "the output should contain \"#{string.sub('spec/fixtures/', './')}\""
+  end
+end

data/features/step_definitions/run_steps.rb

@@ -0,0 +1,17 @@
+Before do
+  FileUtils.mkdir_p 'tmp/aruba'
+end
+
+After do
+  FileUtils.rm_rf 'tmp/aruba'
+end
+
+Given(/^I have (\w+) file in directory$/) do |name|
+  @filename = "#{name}.rb"
+  FileUtils.ln_s "../../spec/fixtures/#{@filename}", 'tmp/aruba/'
+  expect(`ls tmp/aruba`).to match(@filename)
+end
+
+Then(/^warder does nothing$/) do
+  step 'the output should match /.{0}/'
+end

data/features/step_definitions/validates_style_guide_steps.rb

@@ -0,0 +1,6 @@
+Then(/^warder validates style guide$/) do
+  executing_rubocop_output = "executing 'rubocop'"
+  success_rubocop_output = `rubocop spec/fixtures/#{@filename} | grep offence`
+  step "the output should contain \"#{executing_rubocop_output}\""
+  step "the output should contain \"#{success_rubocop_output}\""
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+require 'aruba/cucumber'
+
+bin_path = "#{File.expand_path('../../../bin', __FILE__)}"
+ENV['PATH'] = "#{ENV['PATH']}#{File::PATH_SEPARATOR}#{bin_path}"

data/features/validates_style_guide.feature

@@ -0,0 +1,22 @@
+Feature: check style guide
+  In order to check style guide
+  As a ruby developer
+  I want to run warder with --style-guide option
+
+  Scenario: run warder with enabled style guide option
+    Given I have valid file in directory
+    When I run `warder --style-guide`
+    Then warder validates style guide
+    Then the exit status should be 0
+
+  Scenario: run warder with enabled style guide option on invalid file
+    Given I have invalid_style_guide file in directory
+    When I run `warder --style-guide`
+    Then warder validates style guide
+    Then the exit status should be 1
+
+  Scenario: run warder with disabled style guide option on invalid file
+    Given I have invalid_style_guide file in directory
+    When I run `warder --no-style-guide`
+    Then warder does nothing
+    Then the exit status should be 0

data/lib/warder.rb

@@ -1,2 +1,6 @@
 require 'warder/version'
 require 'warder/runner'
+require 'warder/style_guide_runner'
+require 'warder/magick_numbers_runner'
+require 'warder/code_duplication_runner'
+require 'warder/cli'

data/lib/warder/cli.rb

@@ -0,0 +1,42 @@
+module Warder
+  # responsible for executing warder tools
+  class CLI
+    def initialize(options)
+      @options = options
+    end
+
+    def perform
+      exit perform_style_guide_validation + perform_magick_numbers_validation +
+        perform_code_duplication_validation
+    end
+
+    private
+
+    def perform_style_guide_validation
+      if @options[:style_guide]
+        runner = StyleGuideRunner.new(@options)
+        runner.perform
+      else
+        0
+      end
+    end
+
+    def perform_magick_numbers_validation
+      if @options[:magick_numbers]
+        runner = MagickNumbersRunner.new(@options)
+        runner.perform
+      else
+        0
+      end
+    end
+
+    def perform_code_duplication_validation
+      if @options[:code_duplications]
+        runner = CodeDuplicationRunner.new(@options)
+        runner.perform
+      else
+        0
+      end
+    end
+  end
+end

data/lib/warder/code_duplication_runner.rb

@@ -0,0 +1,22 @@
+module Warder
+  # responsible for run magick numbers validation
+  class CodeDuplicationRunner < Runner
+    FLAY_SCORE = SCORE / 2
+
+    def initialize(options = {})
+      @options = options
+    end
+
+    private
+
+    def command
+      "flay -d -m #{FLAY_SCORE} ."
+    end
+
+    def failed?(line)
+      match = line.match(/Total score \(lower is better\) = (\d+)/)
+
+      match && match[1].to_i != 0
+    end
+  end
+end

data/lib/warder/magick_numbers_runner.rb

@@ -0,0 +1,18 @@
+module Warder
+  # responsible for run magick numbers validation
+  class MagickNumbersRunner < Runner
+    def initialize(options = {})
+      @options = options
+    end
+
+    private
+
+    def command
+      'mago'
+    end
+
+    def failed?(line)
+      true
+    end
+  end
+end

data/lib/warder/runner.rb

@@ -1,24 +1,23 @@
 module Warder
-  # responsible for running tools
+  # abstract class for command runners
   class Runner
-    def run!
-      exit rubocop.to_i + mago.to_i
-    end
-
-    private
-
-    def rubocop
-      system('rubocop')
-      $CHILD_STATUS
-    end
+    SCORE = 30
 
-    def mago
+    def perform
+      puts "executing '#{command}'\n"
       code = 0
-      IO.popen('mago').each do |line|
+      IO.popen(command).each do |line|
         print line
-        code = 1
+
+        code = 1 if failed?(line)
       end
       code
     end
+
+    private
+
+    def failed?(line)
+      false
+    end
   end
 end

data/lib/warder/style_guide_runner.rb

@@ -0,0 +1,20 @@
+module Warder
+  # responsible for run style guide validation
+  class StyleGuideRunner < Runner
+    def initialize(options = {})
+      @options = options
+    end
+
+    private
+
+    def command
+      'rubocop'
+    end
+
+    def failed?(line)
+      match = line.match(/(\d+|no) offence/)
+
+      match && match[1].to_i != 0
+    end
+  end
+end

data/lib/warder/version.rb

@@ -1,4 +1,4 @@
 # define warder version
 module Warder
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/rubocop-todo.yml

@@ -0,0 +1,18 @@
+# This configuration was generated by `rubocop --auto-gen-config`.
+# The point is for the user to remove these configuration records
+# one by one as the offences are removed from the code base.
+
+AssignmentInCondition:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+EmptyLinesAroundBody:
+  Enabled: false
+
+IfUnlessModifier:
+  Enabled: false
+
+UselessAssignment:
+  Enabled: false

data/spec/fixtures/invalid_code_duplications.rb

@@ -0,0 +1,40 @@
+##
+# I am a dog.
+
+class Dog
+  def x
+    return 1
+  end
+
+  def w
+    return 2 + q
+  end
+
+  private
+
+  def q
+    return 3
+  end
+end
+
+##
+# I
+# am
+# a
+# cat.
+
+class Cat
+  def y
+    return 1
+  end
+
+  def z
+    return 2 + s
+  end
+
+  private
+
+  def s
+    return 3
+  end
+end

data/spec/fixtures/invalid_magick_numbers.rb

@@ -0,0 +1 @@
+1 + 1 / 2

data/spec/fixtures/invalid_style_guide.rb

@@ -0,0 +1,3 @@
+module InvalidStyleGuide
+
+end

data/spec/fixtures/strictly_invalid_style_guide.rb

@@ -0,0 +1,3 @@
+if match = ''.match(/(\d+|no) offence/)
+  exit(1)
+end

data/spec/fixtures/valid.rb

@@ -0,0 +1 @@
+puts 'Hello world!'

data/warder.gemspec

@@ -15,16 +15,19 @@ Gem::Specification.new do |spec|
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(spec|features)/})
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|cucumber)/})
   spec.require_paths = ['lib']
 
   spec.add_dependency 'rubocop'
   # spec.add_dependency 'reek'
-  # spec.add_dependency 'flay'
+  spec.add_dependency 'flay'
+  spec.add_dependency 'ruby2ruby'
   # spec.add_dependency 'flog'
   spec.add_dependency 'mago'
 
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec', '3.0.0.beta1'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'aruba'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: warder
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Yura Tolstik
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-22 00:00:00.000000000 Z
+date: 2013-12-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubocop
@@ -24,6 +24,34 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby2ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mago
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +108,34 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 3.0.0.beta1
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: aruba
+  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: Warder of ruby code
 email:
 - yltsrc@gmail.com
@@ -94,9 +150,29 @@ files:
 - README.md
 - Rakefile
 - bin/warder
+- cucumber.yml
+- features/detects_code_duplications.feature
+- features/detects_magick_numbers.feature
+- features/run.feature
+- features/step_definitions/detects_code_duplications_steps.rb
+- features/step_definitions/detects_magick_numbers_steps.rb
+- features/step_definitions/run_steps.rb
+- features/step_definitions/validates_style_guide_steps.rb
+- features/support/env.rb
+- features/validates_style_guide.feature
 - lib/warder.rb
+- lib/warder/cli.rb
+- lib/warder/code_duplication_runner.rb
+- lib/warder/magick_numbers_runner.rb
 - lib/warder/runner.rb
+- lib/warder/style_guide_runner.rb
 - lib/warder/version.rb
+- rubocop-todo.yml
+- spec/fixtures/invalid_code_duplications.rb
+- spec/fixtures/invalid_magick_numbers.rb
+- spec/fixtures/invalid_style_guide.rb
+- spec/fixtures/strictly_invalid_style_guide.rb
+- spec/fixtures/valid.rb
 - spec/spec_helper.rb
 - warder.gemspec
 homepage: https://github.com/yltsrc/warder
@@ -119,9 +195,23 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Warder of ruby code
 test_files:
+- features/detects_code_duplications.feature
+- features/detects_magick_numbers.feature
+- features/run.feature
+- features/step_definitions/detects_code_duplications_steps.rb
+- features/step_definitions/detects_magick_numbers_steps.rb
+- features/step_definitions/run_steps.rb
+- features/step_definitions/validates_style_guide_steps.rb
+- features/support/env.rb
+- features/validates_style_guide.feature
+- spec/fixtures/invalid_code_duplications.rb
+- spec/fixtures/invalid_magick_numbers.rb
+- spec/fixtures/invalid_style_guide.rb
+- spec/fixtures/strictly_invalid_style_guide.rb
+- spec/fixtures/valid.rb
 - spec/spec_helper.rb