ryan 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 043ec6bf0cba3ff0f096fc4b47e2c0580b50f5ca
-  data.tar.gz: d65251331f9a6da616765fc2b854da2f16b9a368
+  metadata.gz: 291fea61132de8ec31f0e70fda31c930a41fc86a
+  data.tar.gz: 9ec06895b0fbd8e8f24cb4333ef443d1e88ffdac
 SHA512:
-  metadata.gz: 6e1a7162edfa879a93cf71d59aff18c73696dadae7a1cde638df7b5b5e2a6aaef592a42cd957b3d6f8fbc5866674b9420ec7d22dc3adfdb152cfd519c031819f
-  data.tar.gz: 022145f0844c32f77eccfb3234295a03e08492e23ec292f575c7ae27a3d2fd826142c55a1d9a1c7fabbac4728725cfbed25da2e1edb08fd347b81074a710f8f0
+  metadata.gz: df0bd56e2f47a7887c2dc5d84c5076665c5343a34cd3971a15efac6be4f323802e2dd6f7b55756d74a27d4ae41784805730d86e66336e967c5d374dc014d68bd
+  data.tar.gz: 309d0f95cf4f7e952d6af7054300402cfb0b8282580179126fddbd8d74beb9df188062526396ccf0dc8ac7f6fb1b003970799716d3397d1c8f4fd234143f15c9

data/.ruby-gemset

@@ -0,0 +1 @@
+ryan

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.2

data/Gemfile

@@ -2,3 +2,5 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in ryan.gemspec
 gemspec
+
+gem 'byebug'

data/README.md

@@ -1,3 +1,100 @@
 # Ryan
 
-Reviews and rewrites rspec files using the style I like
+A wrapper around the awesome [RubyParser](https://github.com/seattlerb/ruby_parser) gem that provides an OO interface for 
+reading Ruby code.
+
+## Installation
+
+```ruby
+gem 'ryan'
+```
+
+## Usage
+
+Give Ryan a Ruby file to play with. Test it out in an IRB session with `bin/console`
+
+```ruby
+ryan = Ryan.new FIXTURE_ROOT.join('report.rb')
+ryan.name 
+#=> "Report"
+ryan.class?
+#=> true
+ryan.module?
+#=> false
+ryan.initialization_args
+#=> [:message]
+ryan.funcs.length 
+#=> 12
+ryan.funcs.reject(&:private?).length 
+#=> 10
+ryan.funcs.first.name 
+#=> :enqueue
+```
+
+### Assignments
+
+```ruby
+func = ryan.func_by_name(:call)
+#=> #<Ryan::InstanceFunc:0x007fd49c10d8d0 @sexp=...>
+func.assignments.length
+#=> 1
+func.assignments.first.name
+#=> :@duder
+```
+
+### Conditions
+
+```ruby
+#=> "assigns @duder"
+func.conditions.length
+#=> 3
+condition = func.conditions.last
+#=> #<Ryan::Condition:0x007fd49c10d8d0 @sexp=...>
+condition.statement
+#=> "report.save"
+condition.full_statement
+#=> "if report.save then\n  UserMailer.spam(user).deliver_now if user.wants_mail?\n  report.perform\nelse\n  ..."
+condition.if_sexp
+#=> s(:call, s(:call, nil, :report), :perform)
+condition.if_text
+#=> "returns report.perform"
+condition.else_text
+#=> ""
+```
+
+### Condition Parts
+
+```ruby
+# Get the parts of the current condition, which will be the any elsif's
+condition.parts.length
+#=> 1
+part = condition.parts.first
+#=> #<Ryan::Condition:0x007fd49ca5a028 @sexp=...>
+part.if_text
+#=> "returns report.force_perform"
+part.else_text
+#=> "returns report.failure"
+```
+
+### Nested Conditions
+
+```ruby
+# Find conditions nested inside this condition
+condition.nested_conditions.length
+#=> 1
+nested_condition = condition.nested_conditions.last
+#=> #<Ryan::Condition:0x007fd49ca8bbf0 @sexp=...>
+nested_condition.if_sexp
+#=> s(:call, s(:call, s(:const, :UserMailer), :spam, s(:call, nil, :user)), :deliver_now)
+nested_condition.if_text
+#=> "returns UserMailer.spam(user).deliver_now"
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` to run the tests. 
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ridiculous/ryan.

data/Rakefile

@@ -1 +1,10 @@
-require "bundler/gem_tasks"
+$LOAD_PATH.unshift './lib'
+require 'ryan'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/lib/**/*_spec.rb'
+end
+
+desc 'Run specs'
+task default: :spec

data/bin/console

@@ -2,6 +2,7 @@
 
 require "bundler/setup"
 require "ryan"
+require_relative "../spec/spec_helper"
 
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.

data/lib/ryan.rb

@@ -1,5 +1,26 @@
-require 'ryan/version'
+require 'ruby_parser'
+require 'forwardable'
 
-module Ryan
-  # todo
+class Ryan
+  autoload :Version, 'ryan/version'
+  autoload :Const, 'ryan/const'
+  autoload :Condition, 'ryan/condition'
+  autoload :Func, 'ryan/func'
+  autoload :ClassFunc, 'ryan/class_func'
+  autoload :InstanceFunc, 'ryan/instance_func'
+  autoload :Assignment, 'ryan/assignment'
+  autoload :SexpDecorator, 'ryan/sexp_decorator'
+
+  attr_reader :sexp, :const
+
+  extend Forwardable
+
+  def_delegators :const,
+    :name, :funcs, :type, :initialization_args, :func_by_name, :class?, :module?
+
+  # @param [Pathname, String] file
+  def initialize(file)
+    @sexp = RubyParser.new.parse File.read(file)
+    @const = Const.new(sexp)
+  end
 end

data/lib/ryan/assignment.rb

@@ -0,0 +1,23 @@
+class Ryan
+  class Assignment
+    attr_reader :sexp
+
+    def initialize(sexp)
+      @sexp = sexp
+    end
+
+    def to_s
+      "assigns #{name}"
+    end
+
+    # @example s(:iasgn, :@duder, s(:if, ...)
+    # @example s(:op_asgn_or, s(:ivar, :@report), ...)
+    def name
+      if sexp.first == :iasgn
+        sexp[1]
+      elsif sexp.first == :op_asgn_or
+        sexp[1][1]
+      end
+    end
+  end
+end

data/lib/ryan/class_func.rb

@@ -0,0 +1,13 @@
+class Ryan::ClassFunc < Ryan::Func
+  def name
+    sexp[2]
+  end
+
+  def args
+    map_args(sexp[3]) if sexp[3].first == :args
+  end
+
+  def class?
+    true
+  end
+end

data/lib/ryan/condition.rb

@@ -0,0 +1,111 @@
+require 'set'
+require 'ruby2ruby'
+
+class Ryan::Condition
+
+  attr_reader :nested_conditions, :sexp, :parts
+
+  def initialize(sexp)
+    @sexp = sexp
+    @nested_conditions = create_nested_conditions
+    @parts = load_parts
+  end
+
+  def full_statement
+    @full_statement ||= Ruby2Ruby.new.process(sexp.deep_clone)
+  end
+
+  def statement
+    edit_statement Ruby2Ruby.new.process(sexp[1].deep_clone)
+  end
+
+  def if_text
+    edit_return_text Ruby2Ruby.new.process(if_sexp.deep_clone)
+  end
+
+  def else_text
+    edit_return_text Ruby2Ruby.new.process(else_sexp.deep_clone)
+  end
+
+  def if_sexp
+    if sexp[2].nil?
+      sexp.last
+    elsif sexp[2].first == :if
+      nil
+    elsif sexp[2].first == :block
+      sexp[2].last
+    elsif sexp[2].first == :rescue
+      sexp[2][1].last
+    else
+      sexp[2]
+    end
+  end
+
+  def else_sexp
+    if sexp.compact[3].nil?
+      nil
+    elsif sexp[3].first == :block
+      sexp[3].last
+    elsif sexp[3].first == :if
+      nil
+    else
+      sexp[3]
+    end
+  end
+
+  #
+  # Private
+  #
+
+  def edit_return_text(txt)
+    txt = txt.to_s
+    txt.sub! /^return\b/, 'returns'
+    txt.sub! /^returns\s*$/, 'returns nil'
+    if txt.include?(' = ')
+      txt = "assigns #{txt}"
+    elsif !txt.empty? and txt !~ /^return/
+      txt = "returns #{txt.strip}"
+    end
+    txt.strip
+  end
+
+  def edit_statement(txt)
+    txt = txt[/(.+)\n?/, 1] # take first line
+    txt.prepend 'unless ' if sexp[2].nil? # this is an unless statement
+    txt
+  end
+
+  # @description handles elsif
+  def load_parts
+    condition_parts = Set.new
+    sexp.each_sexp do |s|
+      if s.first == :if
+        condition_parts << self.class.new(s)
+      end
+    end
+    condition_parts.to_a
+  end
+
+  def create_nested_conditions
+    nc = Set.new
+    s = sexp.drop(1)
+    s.flatten.include?(:if) && s.deep_each do |exp|
+      Ryan::SexpDecorator.new(exp).each_sexp_condition do |node|
+        nc << self.class.new(node)
+      end
+    end
+    nc.to_a
+  end
+
+  #
+  # Set comparison operators
+  #
+
+  def eql?(other)
+    hash == other.hash
+  end
+
+  def hash
+    sexp.object_id
+  end
+end

data/lib/ryan/const.rb

@@ -0,0 +1,97 @@
+class Ryan::Const
+  CLASS_MOD_DEFS = { class: :class, module: :module }
+  CONSTANT_DEFS = { cdecl: :class }.merge CLASS_MOD_DEFS
+  PRIVATE_DEFS = [:private, :protected]
+
+  attr_reader :sexp
+
+  # @param [Sexp] sexp
+  def initialize(sexp)
+    sexp = sexp[2] if sexp[0] == :block
+    @sexp = sexp
+  end
+
+  # @description Extracts the class/mod definition from a Sexp object. Handles stuff that looks like:
+  #   - s(:module, :Admin, s(:class, :Super, nil, s(:class, :UsersController, s(:colon3, :ApplicationController), s(:defn, :name, s(:args)
+  #   - s(:class, :Report, nil, s(:cdecl, :DEFAULT_TZ, s(:str, "UTC")), s(:defs, s(:self), :enqueue,
+  #   - s(:module, s(:colon2, s(:const, :Mixins), :Models))
+  #   - s(:module, :Mixins, s(:module, :Helpers, s(:cdecl, :CSS, s(:str, "height:0"))))
+  #   - s(:module, :Admin, s(:class, :Super, nil, s(:class, :UsersController, s(:colon3, :ApplicationController), s(:defn, :name, s(:args), ...))))
+  def name(sexp = @sexp, list = [])
+    if sexp[1].is_a?(Sexp) && sexp[1][0] == :colon2
+      parts = sexp[1].to_a.flatten
+      list.concat parts.drop(parts.size / 2)
+    elsif CONSTANT_DEFS.key?(sexp[0])
+      list << sexp[1].to_s
+      # skip when the second element is nil; it's just there sometimes and usually indicates the end of the definition
+      if !sexp[2].nil? || (sexp[3].is_a?(Sexp) and CLASS_MOD_DEFS.key?(sexp[3].first))
+        compact_sexp = sexp.compact[2]
+        if CLASS_MOD_DEFS.key?(compact_sexp.first)
+          name(compact_sexp, list)
+        end
+      end
+    end
+    list.join('::')
+  end
+
+  def initialization_args
+    funcs.find(-> { OpenStruct.new }) { |func| func.name == :initialize }.args.to_a.reject { |a| a.to_s.sub(/^\*/, '').empty? }
+  end
+
+  def func_by_name(name_as_symbol)
+    funcs.find { |x| x.name == name_as_symbol }
+  end
+
+  def funcs
+    @funcs ||= load_funcs.flatten
+  end
+
+  def class?
+    type == :class
+  end
+
+  def module?
+    type == :module
+  end
+
+  def type(sexp = @sexp, val = nil)
+    sexp = Array(sexp)
+    if sexp[1].is_a?(Sexp) && sexp[1][0] == :colon2
+      val = sexp[0]
+    elsif CONSTANT_DEFS.key?(sexp[0])
+      val = type(sexp.compact[2], sexp[0])
+    end
+    CONSTANT_DEFS[val]
+  end
+
+  private
+
+  def load_funcs(sexp_list = sexp)
+    marked_private = false
+    sexp_list.map { |node|
+      next unless node.is_a?(Sexp)
+      case node.first
+      when :defn
+        Ryan::InstanceFunc.new(node, marked_private)
+      when :defs
+        Ryan::ClassFunc.new(node, marked_private)
+      when :call
+        marked_private ||= PRIVATE_DEFS.include?(node[2])
+        nil
+      when ->(name) { CONSTANT_DEFS.key?(name) }
+        # @note handle diz kind stuff:
+        #   s(:class, :VerificationCode, nil, s(:defs, s(:self), :find, s(:args, :*)))
+        # and
+        #   s(:module, :ConditionParsers, s(:class, :ReturnValue, ...))
+        # and
+        #   s(:class, :NotificationPresenter, nil, s(:call, nil, :extend, s(:const, :Forwardable)), s(:call, nil, :attr_reader, ...))
+        load_funcs(node.compact.drop(2))
+      else
+        # @todo uncomment with logger at debug level
+        #   puts "got #{__method__} with #{node.first} and don't know how to handle it"
+        # @note :const seems to indicate module inclusion/extension
+        nil
+      end
+    }.compact
+  end
+end

data/lib/ryan/func.rb

@@ -0,0 +1,41 @@
+class Ryan::Func
+  attr_accessor :sexp, :_private
+
+  alias private? _private
+
+  def initialize(sexp, _private)
+    @sexp, @_private = sexp, _private
+  end
+
+  def conditions
+    @conditions ||= Ryan::SexpDecorator.new(sexp).each_sexp_condition.map &Ryan::Condition.method(:new)
+  end
+
+  def assignments
+    nodes = find_assignments(sexp)
+    sexp.find_nodes(:rescue).each do |node|
+      node = node[1] if node[1].first == :block
+      nodes.concat find_assignments(node)
+    end
+    nodes.map &Ryan::Assignment.method(:new)
+  end
+
+  def find_assignments(s_expression)
+    s_expression.find_nodes(:op_asgn_or) + s_expression.find_nodes(:iasgn)
+  end
+
+  # @note we drop(1) to get rid of :args (which should be the first item in the sexp)
+  # @note called from subclasses
+  def map_args(_sexp = sexp, list = [])
+    val = _sexp.first
+    return list.drop(1) unless val
+    case val
+    when Symbol
+      map_args(_sexp.drop(1), list << val)
+    when Sexp
+      map_args(_sexp.drop(1), list << val[1])
+    else
+      nil
+    end
+  end
+end

data/lib/ryan/instance_func.rb

@@ -0,0 +1,13 @@
+class Ryan::InstanceFunc < Ryan::Func
+  def name
+    sexp[1]
+  end
+
+  def args
+    map_args(sexp[2]) if sexp[2].first == :args
+  end
+
+  def class?
+    false
+  end
+end

data/lib/ryan/sexp_decorator.rb

@@ -0,0 +1,22 @@
+require 'delegate'
+
+class Ryan::SexpDecorator < DelegateClass(Sexp)
+  def each_sexp_condition
+    return enum_for(__method__) unless block_given?
+    yielded = []
+    each_sexp do |exp|
+      if exp.first == :if
+        yield exp
+        yielded << exp
+      else
+        nested_sexp = exp.enum_for(:deep_each).select { |s| s.first == :if }
+        nested_sexp.each do |sexp|
+          if yielded.find { |x| x.object_id == sexp.object_id or x.enum_for(:deep_each).find { |xx| xx.object_id == sexp.object_id } }.nil?
+            yield sexp
+            yielded << sexp
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ryan/version.rb

@@ -1,3 +1,3 @@
-module Ryan
-  VERSION = '0.1.0'.freeze
+class Ryan
+  VERSION = '1.0.0'.freeze
 end

data/ryan.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ["Ryan Buckley"]
   spec.email         = ["arebuckley@gmail.com"]
 
-  spec.summary       = %q{Reviews and rewrites rspec files}
-  spec.description   = %q{Reviews and rewrites rspec files using the style I like}
+  spec.summary       = %q{Ryan meet Ruby}
+  spec.description   = %q{A wrapper around the RubyParser gem}
   spec.homepage      = "https://github.com/ridiculous/ryan"
 
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
@@ -20,4 +20,8 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.10"
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", ">= 3.2", "< 4"
+
+  spec.add_dependency 'ruby_parser', '>= 3.7.0', '< 4.0.0'
+  spec.add_dependency 'ruby2ruby', '~> 2.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ryan
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-11 00:00:00.000000000 Z
+date: 2015-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,7 +38,61 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Reviews and rewrites rspec files using the style I like
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: ruby_parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.7.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: ruby2ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: A wrapper around the RubyParser gem
 email:
 - arebuckley@gmail.com
 executables: []
@@ -46,6 +100,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -53,6 +109,13 @@ files:
 - bin/console
 - bin/setup
 - lib/ryan.rb
+- lib/ryan/assignment.rb
+- lib/ryan/class_func.rb
+- lib/ryan/condition.rb
+- lib/ryan/const.rb
+- lib/ryan/func.rb
+- lib/ryan/instance_func.rb
+- lib/ryan/sexp_decorator.rb
 - lib/ryan/version.rb
 - ryan.gemspec
 homepage: https://github.com/ridiculous/ryan
@@ -74,8 +137,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Reviews and rewrites rspec files
+summary: Ryan meet Ruby
 test_files: []