mago 0.0.5 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d37b226405e663e2097987a53497f9be0203feb6
-  data.tar.gz: 3fa69b1d2749e3d9cf2f86574a85f11318ddc255
+  metadata.gz: 4c74fb610902c60e56bb26d0b64eafa820c65fff
+  data.tar.gz: ff885d004ea58452cae383bb4f5a71d8bb15c0b9
 SHA512:
-  metadata.gz: ef14e1c8a0a321b2b70ba99e29883e58850d5edb208bcb8f3921b83910e3259d2577714c18de06eb6724785f940f008f0d9d9800a58660654d78cb48799a578d
-  data.tar.gz: 882f0ca028c606039c71e5893a570be4fdc2bc1d147f1fa0a60989564a833a9bf9f36ce07e4ea1c93252e002e68c59d9da7628b3dda05bf22cdb2019715bb2bc
+  metadata.gz: cd48970c17f3d583d8a07b43a68efbe8595786d3c2ab5f58813c9d5c8761cdc3d75faab3bd3667674c7b0c47ad46c9d56ad7d3ff3d084a56584d666bae1de5ef
+  data.tar.gz: c9bc80c552d2b09d507613ea4c10f6fa22388b2d8193034cd896d86cb094baef6f3d6313170b2aad2b6f14b6095c11c8f25e05a3765f1646b73e7c858f9628e2

data/README.markdown

@@ -1,7 +1,18 @@
 # Mago
 
-Tool to detect magic numbers in ruby code.
+[![Build Status](https://travis-ci.org/greyblake/mago.png?branch=master)](https://travis-ci.org/greyblake/mago)
 
+Magic numbers detector for Ruby source code.
+
+![Mago - magic numbers detector for Ruby](http://i1078.photobucket.com/albums/w484/greyblake/ruby-mago.png)
+
+## Magic numbers
+
+Magic numbers (unnamed constants) are considered as a bad programming practice. Extracting them into constants or explaining variables usually provides the following advantages:
+* It is easier to read and understand.
+* It is easier to alter the value of the number, as it is not duplicated.
+* It may facilitate parameterization.
+* It helps to detect typos.
 
 ## Installation
 
@@ -49,11 +60,40 @@ mago -s ./square.rb
 
 Use `--color` or `-c` option to colorize output.
 
-## TODO
 
-* Add intro about magic numbers to README.
-* Create GIF with some famous probject to show how it works.
+## Using API
+
 
+See [complete documentation](http://rubydoc.info/gems/mago/) at rubydoc.
+Here is a simple example:
+
+```ruby
+require 'mago'
+
+# Initialize detector with ruby files and options
+detector = Mago::Detector.new(['./square.rb', './math/fibonacci.rb'], :ignore => [1,2,3])
+
+# Run detector it to build a report
+report = detector.run  # => #<Mago::Report ...>
+
+# Use report as you want. The following code provides an output like this:
+#  ./square.rb
+#      Line 3:  5
+#      Line 6:  0
+#  ./math/fibonacci.rb
+#      Line 1:  0.0
+#      Line 6:  5.0
+report.files.each do |file|
+  puts file.path
+  file.magic_numbers.each do |number|
+    puts "    Line #{number.line}:  #{number.value}"
+  end
+end
+
+report.errors.each do |error|
+  puts "ERROR: #{error}"
+end
+```
 ## Copyright
 
 Copyright (c) 2013 Sergey Potapov. See LICENSE.txt for

data/lib/mago/cli/command.rb

@@ -75,12 +75,19 @@ module Mago
       def run
         ruby_files = Mago::Cli::FileFinder.new(@config.files).find
         detector   = Mago::Detector.new(ruby_files, :ignore => @config.ignore)
-        report     = detector.run
 
         formatter_class = @config.source ? SourceFormatter : Formatter
-        formatter  = formatter_class.new(report, :color => @config.color)
+        formatter  = formatter_class.new(:color => @config.color)
 
-        puts formatter.format
+        detector.on_file do |file|
+          print formatter.format_file(file)
+        end
+
+        detector.on_error do |error|
+          warn formatter.format_error(error)
+        end
+
+        detector.run
       end
 
       # Show help message.

data/lib/mago/cli/formatter.rb

@@ -4,42 +4,41 @@ module Mago
     class Formatter
       include Colorize
 
-      # @param report [Mago::Report]
       # @param opts [Hash]
       #
       # @option opts :color [Boolean] whether colorize output or no
-      def initialize(report, opts = {})
-        @report = report
-        @color  = opts[:color]
+      def initialize(opts = {})
+        @color = opts[:color]
       end
 
       # Format report.
       #
+      # @param report [Mago::Report]
+      #
       # @return [String] formated report
-      def format
+      def format(report)
         out = ''
 
-        @report.files.each do |file|
-          format_file(file, out)
+        report.files.each do |file|
+          out << format_file(file, out)
         end
 
-        @report.errors.each do |error|
-          format_error(error, out)
+        report.errors.each do |error|
+          out << format_error(error)
         end
 
         out
       end
 
 
-      private
-
       # Format file with magic numbers.
       #
       # @param file [Mago::File]
-      # @param out [String] string to write result
       #
       # @return [void]
-      def format_file(file, out)
+      def format_file(file)
+        out = ''
+
         file.magic_numbers.each do |num|
           if @color
             val  = red(num.value)
@@ -53,16 +52,18 @@ module Mago
 
           out << "#{path}:#{line} detected magic number #{val}\n"
         end
+
+        out
       end
 
       # Format error.
       #
       # @param error [String] error message
-      # @param out [String] string to write result
       #
       # @return [void]
-      def format_error(error, out)
-        out << "ERROR: %s\n" % [error]
+      def format_error(error)
+        out = "ERROR: #{error}"
+        @color ? red(out) : out
       end
     end
   end

data/lib/mago/cli/source_formatter.rb

@@ -3,7 +3,8 @@ module Mago
     # Formats report showing lines of source code where magic number was detected.
     class SourceFormatter < Formatter
       # :nodoc:
-      def format_file(file, out)
+      def format_file(file)
+        out = ''
         source_lines = File.readlines(file.path)
 
         file.magic_numbers.each do |num|
@@ -19,6 +20,8 @@ module Mago
 
           out << "#{path}:#{line}| #{source_line}"
         end
+
+        out
       end
 
       # Find a substing in a string and make it red.

data/lib/mago/detector.rb

@@ -28,6 +28,16 @@ module Mago
       @report
     end
 
+    # Set callback to be called when file processing is finished.
+    def on_file(&block)
+      @on_file = block
+    end
+
+    # Set callback to be called when error occurs.
+    def on_error(&block)
+      @on_error = block
+    end
+
 
     private
 
@@ -45,11 +55,22 @@ module Mago
       sexp_processor.process(sexp_node)
 
       @report.files << file
+      @on_file.call(file) if @on_file
     rescue Errno::ENOENT => err
-      @report.errors << err.message
-    rescue Racc::ParseError => err
+      handle_error(err.message)
+    rescue Racc::ParseError, Encoding::CompatibilityError => err
       msg = "#{path} has invalid ruby code. " << err.message
-      @report.errors << msg
+      handle_error(msg)
+    end
+
+    # Add error to report and call on_error callback if it's set.
+    #
+    # @param error [String]
+    #
+    # @return [void]
+    def handle_error(error)
+      @on_error.call(error) if @on_error
+      @report.errors << error
     end
   end
 end

data/lib/mago/version.rb

@@ -1,4 +1,4 @@
 module Mago
   # :nodoc:
-  VERSION = '0.0.5'
+  VERSION = '0.1.0'
 end

data/spec/integration/cli_spec.rb

@@ -1,32 +1,39 @@
 require 'spec_helper'
 
 describe 'mago command' do
+  # Run mago command. Return stdout and stderr.
   def mago(args = '')
     cmd = "cd #{FIXTURES_PATH} && #{MAGO_BIN} #{args}"
-    %x"#{cmd}"
+
+    stdin, stdout, stderr, thread = Open3.popen3(cmd)
+    thread.join
+
+    [stdout.read, stderr.read]
   end
 
+
+
   describe 'arguments' do
     it 'without arguments should look through ruby files in the current directory' do
-      output = mago('')
+      stdout, stderr = mago('')
 
-      output.should include('./square.rb')
-      output.should include('./math/fibonacci.rb')
-      output.should include('./invalid.rb')
+      stdout.should include('./square.rb')
+      stdout.should include('./math/fibonacci.rb')
+      stderr.should include('./invalid.rb')
     end
 
     it 'when directory passed should inspect all ruby files inside' do
-      output = mago('./math/')
+      stdout, stderr = mago('./math/')
 
-      output.should include('./math/fibonacci.rb')
-      output.should_not include('square')
+      stdout.should include('./math/fibonacci.rb')
+      stdout.should_not include('square')
     end
   end
 
   context 'ruby file with invalid syntax' do
     it 'should report files with syntax errors' do
-      output = mago('./invalid.rb')
-      output.should include('ERROR: ./invalid.rb has invalid ruby code')
+      stdout, stderr = mago('./invalid.rb')
+      stderr.should include('ERROR: ./invalid.rb has invalid ruby code')
     end
   end
 
@@ -34,9 +41,10 @@ describe 'mago command' do
   describe 'options' do
     context 'without options' do
       it 'should detect magic number except 0 and 1' do
-        mago('./square.rb').should ==
-          "./square.rb:3 detected magic number 5\n" \
-          "./square.rb:4 detected magic number 2\n"
+        stdout, stderr = mago('./square.rb')
+
+        stdout.should include("./square.rb:3 detected magic number 5\n")
+        stdout.should include("./square.rb:4 detected magic number 2\n")
       end
     end
 
@@ -45,8 +53,11 @@ describe 'mago command' do
         expected = "./square.rb:3 detected magic number 5\n"\
                    "./square.rb:3 detected magic number 1\n"
 
-        mago('--ignore 0,2 ./square.rb').should == expected
-        mago('-i 0,2 ./square.rb').should == expected
+        stdout, stderr = mago('--ignore 0,2 ./square.rb')
+        stdout.should == expected
+
+        stdout, stderr = mago('-i 0,2 ./square.rb')
+        stdout.should == expected
       end
     end
   end
@@ -56,8 +67,11 @@ describe 'mago command' do
       expected = "./square.rb:3| radius = 5 - 1\n" \
                  "./square.rb:4| square = P * radius ** 2\n"
 
-      mago('--source ./square.rb').should == expected
-      mago('-s ./square.rb').should == expected
+      stdout, stderr = mago('--source ./square.rb')
+      stdout.should == expected
+
+      stdout, stderr = mago('-s ./square.rb')
+      stdout.should == expected
     end
   end
 end

data/spec/spec_helper.rb

@@ -3,6 +3,8 @@ $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
 require 'mago'
 
+require 'open3'
+
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mago
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.1.0
 platform: ruby
 authors:
 - Sergey Potapov