mago 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bff22636bac0787bd8a88f2889e8f076f4f5fe61
-  data.tar.gz: 2073a8323b25fd5ad67b771181513bc5c135977e
+  metadata.gz: 069e929006e5cab92bbebe28e6eca37476916809
+  data.tar.gz: 44440710c44bbffecc85f180bbbe96869e03e2b5
 SHA512:
-  metadata.gz: 6cfab0b16c68d008dcf9564bc2233297e1d145e46e42629441ca12a9ac6cfff2cba9be3e4e1029da0a75d5700959bee795992572b67f23cef474884bb4ca63e4
-  data.tar.gz: 872e646954a12c6f9eed35b5d3ceb6bffff97bd73a4c5e055b019516fd2f1dc7f685425782ca71c059027f54f0c0027ff1064b085e95ea1c7060c3d76bd8981c
+  metadata.gz: cebe0d24c4832b0a43669da316276faf4fc5204a1e1a3f79fc37ee7403a9ffd0bea4be21d0f9965bc58f30545a759f9aeb88813fa03ab952866e62f5239e7579
+  data.tar.gz: 1e7f38b8af6c6ccbc10fe85bb117f670ed5899880a2b2b69a7e3773aec2d4397d146bd5d6575f88fc2474da5f4b6ba7a3a76526d7e6f5915d37f8a489c3f35cd

data/README.markdown

@@ -9,20 +9,7 @@ Tool to detect magic numbers in ruby code.
 gem install mago
 ```
 
-
-## Usage
-
-Detect magic numbers in particular ruby file:
-```sh
-mago ./path/to/file.rb
-```
-
-In all ruby files inside directory:
-```sh
-mago ./path/to/project/
-```
-
-## Example
+## Usage example
 
 Ruby code in `square.rb`:
 ```ruby
@@ -39,6 +26,23 @@ mago ./square.rb
 ./square.rb:4 detected magic number 2
 ```
 
+### Ignoring specific numbers
+
+Use `--ignore` or `-i` option to ignore specific numbers. By default 0 and 1 are ignored.
+
+```sh
+mago -i 2,3 ./square.rb
+./square.rb:3 detected magic number 5
+```
+
+### Color output
+
+Use `--color` or `-c` option to colorize output.
+
+## TODO
+
+* Support for `--show-source`(`-s`) option to show line of source code with magic number.
+* Support for `--expl-var` (`-e`) option to ignore explaining variables.
 
 ## Copyright
 

data/bin/mago

@@ -3,46 +3,6 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
 require 'mago'
+require 'mago/cli'
 
-def run(args)
-  case args.first
-  when '--help', '-h'
-    show_help
-  when '--version', '-v'
-    show_version
-  else
-    run_mago(args)
-  end
-end
-
-def run_mago(args)
-
-  if args.empty?
-    args << '.'
-  end
-
-  ruby_files = Mago::FileFinder.new(args).find
-  processor = Mago::Detector.new(ruby_files, :ignore => [0, 1])
-  report = processor.run
-  formatter = Mago::Formatter.new(report)
-  puts formatter.format
-end
-
-def show_help
-  puts "Description:\n" \
-       "    Magic numbers detector for ruby\n\n"\
-       "Usage:\n" \
-       "   mago                     # inspect ruby files in current directory\n" \
-       "   mago ./my_code.rb        # inspect ./my_code.rb file\n" \
-       "   mago ./my_project/       # inspect ruby files in ./my_project/"
-end
-
-
-def show_version
-  puts "Mago #{Mago::VERSION}\n" \
-       "Tool to detect magic numbers in ruby files.\n" \
-       "Copyright (c) 2013 Sergey Potapov"
-end
-
-
-run(ARGV)
+Mago::Cli::Command.new(ARGV).execute

data/lib/mago.rb

@@ -6,7 +6,6 @@ require 'mago/ruby_file'
 require 'mago/sexp_processor'
 require 'mago/detector'
 require 'mago/report'
-require 'mago/formatter'
 require 'mago/file_finder'
 require 'mago/version'
 

data/lib/mago/cli.rb

@@ -0,0 +1,9 @@
+require 'mago/cli/colorize'
+require 'mago/cli/command'
+require 'mago/cli/formatter'
+
+module Mago
+  module Cli
+
+  end
+end

data/lib/mago/cli/colorize.rb

@@ -0,0 +1,25 @@
+module Mago
+  module Cli
+    module Colorize
+      def colorize(text, color_code)
+        "\e[#{color_code}m#{text}\e[0m"
+      end
+
+      def red(text)
+        colorize(text, 31)
+      end
+
+      def green(text)
+        colorize(text, 32)
+      end
+
+      def yellow(text)
+        colorize(text, 33)
+      end
+
+      def pink(text)
+        colorize(text, 35)
+      end
+    end
+  end
+end

data/lib/mago/cli/command.rb

@@ -0,0 +1,83 @@
+module Mago
+  module Cli
+    class Config
+      attr_accessor :ignore, :files, :color
+
+      def initialize
+        @files = []
+        @color = false
+      end
+    end
+
+    class Command
+      def initialize(args)
+        @args = args
+        @config = Config.new
+      end
+
+      def execute
+        parse_args
+        run
+      end
+
+      def parse_args
+        while arg = @args.shift
+          case arg
+          when '--help', '-h'
+            show_help
+            exit 0
+          when '--version', '-v'
+            show_version
+            exit 0
+          when '--ignore', '-i'
+            val = @args.shift
+            abort "--ignore option requires comma separated numbers" unless val =~ /^[0-9]/
+            nums = val.to_s.split(',').map{ |n| n.include?('.') ? n.to_f : n.to_i }
+            @config.ignore = nums
+          when '--color', '--colour', '-c'
+            @config.color = true
+          when /^-/
+            abort("Unknown option `#{arg}'")
+          else
+            @config.files << arg
+          end
+        end
+
+        @config.files << '.' if @config.files.empty?
+      end
+
+
+      private
+
+      def run
+        ruby_files = Mago::FileFinder.new(@config.files).find
+        detector   = Mago::Detector.new(ruby_files, :ignore => @config.ignore)
+        report     = detector.run
+        formatter  = Mago::Cli::Formatter.new(report, :color => @config.color)
+
+        puts formatter.format
+      end
+
+      def show_help
+        puts "Magic numbers detector for Ruby programming language.\n\n" \
+             "  Syntax:\n" \
+             "    mago [OPTIONS] [FILES]\n\n" \
+             "  Options:\n" \
+             "    -i, --ignore NUMS\n" \
+             "        Comma separated numbers, which will be ignored. Default is 0,1\n\n" \
+             "  Usage:\n" \
+             "    mago                     # inspect ruby files in current directory\n" \
+             "    mago ./my_code.rb        # inspect ./my_code.rb file\n" \
+             "    mago ./my_project/       # inspect ruby files in ./my_project/"
+      end
+
+
+      def show_version
+        puts "Mago #{Mago::VERSION}\n" \
+             "Tool to detect magic numbers in ruby files.\n" \
+             "Copyright (c) 2013 Sergey Potapov"
+      end
+
+    end
+  end
+end

data/lib/mago/cli/formatter.rb

@@ -0,0 +1,47 @@
+module Mago
+  module Cli
+    class Formatter
+      include Colorize
+
+      def initialize(report, opts = {})
+        @report = report
+
+        @color = opts[:color]
+      end
+
+      def format
+        out = ''
+
+        @report.files.each do |file|
+          format_file(file, out)
+        end
+
+        @report.errors.each do |error|
+          format_error(error, out)
+        end
+
+        out
+      end
+
+      def format_file(file, out)
+        file.magic_numbers.each do |num|
+          if @color
+            val  = red(num.value)
+            line = yellow(num.line)
+            path = pink(file.path)
+          else
+            val  = num.value
+            line = num.line
+            path = file.path
+          end
+
+          out << "#{path}:#{line} detected magic number #{val}\n"
+        end
+      end
+
+      def format_error(error, out)
+        out << "ERROR: %s\n" % [error]
+      end
+    end
+  end
+end

data/lib/mago/detector.rb

@@ -1,9 +1,12 @@
 module Mago
   class Detector
+    # Numbers which are ignored by default
+    DEFAULT_IGNORE = [0, 1]
+
     def initialize(file_paths = [], options = {})
       @file_paths = file_paths
       @report = Report.new
-      @ignore = options[:ignore] || []
+      @ignore = options[:ignore] || DEFAULT_IGNORE
     end
 
     def run

data/lib/mago/file_finder.rb

@@ -5,18 +5,18 @@ module Mago
     end
 
     def find
-      file_paths = []
+      ruby_files = []
 
       @paths.each do |path|
         if File.directory?(path)
-          dir_files = Dir["#{path}/**/*.rb"]
-          file_paths.concat(dir_files)
+          pattern = File.join(path, '/**/*.rb')
+          ruby_files.concat(Dir[pattern])
         else
-          file_paths << path
+          ruby_files << path
         end
       end
 
-      file_paths
+      ruby_files
     end
   end
 end

data/lib/mago/version.rb

@@ -1,3 +1,3 @@
 module Mago
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/fixtures/invalid.rb

@@ -0,0 +1 @@
+f - - -

data/spec/fixtures/math/fibonacci.rb

@@ -0,0 +1,6 @@
+puts 0.0
+puts 1.0
+puts 1.0
+puts 2.0
+puts 3.0
+puts 5.0

data/spec/fixtures/square.rb

@@ -0,0 +1,6 @@
+P = 3.14
+
+radius = 5 - 1
+square = P * radius ** 2
+
+raise("Wow!") if square < 0

data/spec/integration/cli_spec.rb

@@ -0,0 +1,53 @@
+require 'spec_helper'
+
+describe 'mago command' do
+  def mago(args = '')
+    cmd = "cd #{FIXTURES_PATH} && #{MAGO_BIN} #{args}"
+    %x"#{cmd}"
+  end
+
+  describe 'arguments' do
+    it 'without arguments should look through ruby files in the current directory' do
+      output = mago('')
+
+      output.should include('./square.rb')
+      output.should include('./math/fibonacci.rb')
+      output.should include('./invalid.rb')
+    end
+
+    it 'when directory passed should inspect all ruby files inside' do
+      output = mago('./math/')
+
+      output.should include('./math/fibonacci.rb')
+      output.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')
+    end
+  end
+
+
+  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"
+      end
+    end
+
+    describe '--ignore option' do
+      it 'should ignore passed numbers' 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
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -7,6 +7,9 @@ require 'mago'
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
 
+FIXTURES_PATH = File.expand_path('../fixtures', __FILE__)
+MAGO_BIN = File.expand_path('../../bin/mago', __FILE__)
+
 RSpec.configure do |config|
-  
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mago
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Sergey Potapov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-09 00:00:00.000000000 Z
+date: 2013-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -55,14 +55,19 @@ files:
 - ./lib/mago/ruby_file.rb
 - ./lib/mago/sexp_processor.rb
 - ./lib/mago/detector.rb
-- ./lib/mago/formatter.rb
+- ./lib/mago/cli.rb
+- ./lib/mago/cli/formatter.rb
+- ./lib/mago/cli/command.rb
+- ./lib/mago/cli/colorize.rb
 - ./lib/mago/magic_number.rb
 - ./bin/mago
 - LICENSE.txt
 - README.markdown
-- ./spec/mago_spec.rb
 - ./spec/spec_helper.rb
-- ./spec/fixtures/code.rb
+- ./spec/fixtures/math/fibonacci.rb
+- ./spec/fixtures/square.rb
+- ./spec/fixtures/invalid.rb
+- ./spec/integration/cli_spec.rb
 - bin/mago
 homepage: https://github.com/greyblake/mago
 licenses:
@@ -89,7 +94,9 @@ signing_key:
 specification_version: 4
 summary: Tool to detect magic numbers in ruby code
 test_files:
-- ./spec/mago_spec.rb
 - ./spec/spec_helper.rb
-- ./spec/fixtures/code.rb
+- ./spec/fixtures/math/fibonacci.rb
+- ./spec/fixtures/square.rb
+- ./spec/fixtures/invalid.rb
+- ./spec/integration/cli_spec.rb
 has_rdoc: 

data/lib/mago/formatter.rb

@@ -1,31 +0,0 @@
-module Mago
-  class Formatter
-    def initialize(report)
-      @report = report
-    end
-
-    def format
-      out = ''
-
-      @report.files.each do |file|
-        format_file(file, out)
-      end
-
-      @report.errors.each do |error|
-        format_error(error, out)
-      end
-
-      out
-    end
-
-    def format_file(file, out)
-      file.magic_numbers.each do |num|
-        out << "%s:%d detected magic number %s\n" % [file.path, num.line, num.value]
-      end
-    end
-
-    def format_error(error, out)
-      out << "ERROR: %s\n" % [error]
-    end
-  end
-end

data/spec/fixtures/code.rb

@@ -1,10 +0,0 @@
-P = 3.14
-
-puts :a
-
-a = 2
-if a > 10.2
-  puts "Hello"
-end
-
- fds

data/spec/mago_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Mago" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end