mago 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 77fd55c4d56257d4dc41f3a1cdf03954ba2b6b16
+  data.tar.gz: 9a301c32e80fd137e237da87c1ca58b070173315
+SHA512:
+  metadata.gz: 382966a551072fc4efe10f8341b138e5724b17a777b8df0f56f064c07b9c696fb04d75222c963980056abc0a84195419ca38564fce665a0f4c5095eb588f645b
+  data.tar.gz: b7d9a3691cf8ee754ecc1ef82187e6a2fdc4fc74d1fb8d619917acfb21953444cc61051cc0b7d04f807d226ec47e7d2d79ae4ba5dc675522ff3321a365c00b15

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Potapov Sergey
+
+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.markdown

@@ -0,0 +1,45 @@
+# Mago
+
+Tool to detect magic numbers in ruby code.
+
+
+## Installation
+
+```
+gem install mago
+```
+
+
+## Usage
+
+Detect magic numbers in particular ruby file:
+```sh
+mago ./path/to/file.rb
+```
+
+In all ruby files of directory:
+```sh
+mago ./path/to/project/
+```
+
+## Example
+
+```ruby
+P = 3.14
+
+radius = 5
+square = P * radius ** 2
+```
+
+```sh
+mago ./square.rb
+./square.rb:3 detected magic number 5
+./square.rb:4 detected magic number 2
+```
+
+
+## Copyright
+
+Copyright (c) 2013 Sergey Potapov. See LICENSE.txt for
+further details.
+

data/lib/mago.rb

@@ -0,0 +1,14 @@
+require 'ruby_parser'
+require 'sexp_processor'
+
+require 'mago/magic_number'
+require 'mago/ruby_file'
+require 'mago/sexp_processor'
+require 'mago/detector'
+require 'mago/report'
+require 'mago/formatter'
+require 'mago/file_finder'
+require 'mago/version'
+
+module Mago
+end

data/lib/mago/detector.rb

@@ -0,0 +1,33 @@
+module Mago
+  class Detector
+    def initialize(file_paths = [], options = {})
+      @file_paths = file_paths
+      @report = Report.new
+      @ignore = options[:ignore] || []
+    end
+
+    def run
+      @file_paths.each do |path|
+        process_file(path)
+      end
+      @report
+    end
+
+    def process_file(path)
+      code = File.read(path)
+      sexp_node = RubyParser.new.parse(code)
+
+      file = Mago::RubyFile.new(path)
+
+      sexp_processor = Mago::SexpProcessor.new(file, @ignore)
+      sexp_processor.process sexp_node
+
+      @report.files << file
+    rescue Errno::ENOENT => err
+      @report.errors << err.message
+    rescue Racc::ParseError => err
+      msg = "#{path} has invalid ruby code. " << err.message
+      @report.errors << msg
+    end
+  end
+end

data/lib/mago/file_finder.rb

@@ -0,0 +1,22 @@
+module Mago
+  class FileFinder
+    def initialize(paths)
+      @paths = paths
+    end
+
+    def find
+      file_paths = []
+
+      @paths.each do |path|
+        if File.directory?(path)
+          dir_files = Dir["#{path}/**/*.rb"]
+          file_paths.concat(dir_files)
+        else
+          file_paths << path
+        end
+      end
+
+      file_paths
+    end
+  end
+end

data/lib/mago/formatter.rb

@@ -0,0 +1,31 @@
+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/lib/mago/magic_number.rb

@@ -0,0 +1,14 @@
+module Mago
+  class MagicNumber
+    attr_accessor :value
+    attr_accessor :line
+    attr_accessor :file
+
+    def initialize(attrs = {})
+      attrs.each do |attr, value|
+        send("#{attr}=", value)
+      end
+    end
+
+  end
+end

data/lib/mago/report.rb

@@ -0,0 +1,10 @@
+module Mago
+  class Report
+    attr_reader :files, :errors
+
+    def initialize
+      @files = []
+      @errors = []
+    end
+  end
+end

data/lib/mago/ruby_file.rb

@@ -0,0 +1,10 @@
+module Mago
+  class RubyFile
+    attr_reader :path, :magic_numbers
+
+    def initialize(path)
+      @path = path
+      @magic_numbers = []
+    end
+  end
+end

data/lib/mago/sexp_processor.rb

@@ -0,0 +1,37 @@
+module Mago
+  class SexpProcessor < ::SexpProcessor
+
+    def initialize(file, ignore = [])
+      super()
+      self.warn_on_default = false
+      self.strict = false
+
+      @file   = file
+      @ignore = ignore
+    end
+
+    def process_cdecl(exp)
+      process_default(exp)
+    end
+
+    def process_lit(exp)
+      exp.shift
+      value = exp.shift
+
+      if value.is_a?(Numeric) && !@ignore.include?(value)
+        @file.magic_numbers << MagicNumber.new(:value => value, :line => exp.line)
+      end
+
+      s()
+    end
+
+    def process_default(exp)
+      until exp.size == 0
+        exp.shift
+      end
+      s()
+    end
+
+  end
+end
+

data/lib/mago/version.rb

@@ -0,0 +1,3 @@
+module Mago
+  VERSION = '0.0.1'
+end

data/spec/fixtures/code.rb

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

data/spec/mago_spec.rb

@@ -0,0 +1,7 @@
+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

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rspec'
+require 'mago'
+
+# Requires supporting files with custom matchers and macros, etc,
+# in ./support/ and its subdirectories.
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: mago
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sergey Potapov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-10-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  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: sexp_processor
+  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'
+description: Provides a command and API to detect magic numbers in ruby code
+email:
+- blake131313@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.markdown
+files:
+- ./lib/mago.rb
+- ./lib/mago/report.rb
+- ./lib/mago/file_finder.rb
+- ./lib/mago/version.rb
+- ./lib/mago/ruby_file.rb
+- ./lib/mago/sexp_processor.rb
+- ./lib/mago/detector.rb
+- ./lib/mago/formatter.rb
+- ./lib/mago/magic_number.rb
+- LICENSE.txt
+- README.markdown
+- ./spec/mago_spec.rb
+- ./spec/spec_helper.rb
+- ./spec/fixtures/code.rb
+homepage: https://github.com/greyblake/mago
+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.0.3
+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
+has_rdoc: