drg 0.13.1 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 85174e3e29ba49bc66bfe16c2bbb52f899d40116
-  data.tar.gz: 5785cf7041e4c15d485573440c4f751866fb0180
+  metadata.gz: 8b762ca2893927b7c8daa8f20f406b94cc9aad2f
+  data.tar.gz: ccd11fadf6b920aabf92352cdf326a913a6de90c
 SHA512:
-  metadata.gz: 08141b4e861f2cf2ba363411d5d560a27ad80b03d9bbe0262fcd5034a2216248171b0de5ac3040b3f6e6b12f9708f5923ebf6f650765b76aa4b1b86a3d908859
-  data.tar.gz: 7f2cc1e22edc346890f195623248e0afbed948cfe79647951f810dad05e5afe8028133000b9cf6b82685339d866d5f68c3adfb3ddec7e11d0ee62097d46a5ad8
+  metadata.gz: 27a26be99bed739f410282a8f161713d7c3066b8a50a04902b783e33b667dbfa1654bee482aab0d0b4c4359bf4441e714c15fb86d3249225bf7a8ba16fb5fd53
+  data.tar.gz: 984f714b1a1371c4e71420c11cfa61b6a98e2c5fa119872bf1d3c94de4c536b7567bc386540ce7e0240e1af66035660734cbf6b3447bf81031b13e665ba9dae4

data/README.md

@@ -2,8 +2,13 @@
 [![Code Climate](https://codeclimate.com/github/ridiculous/drg/badges/gpa.svg)](https://codeclimate.com/github/ridiculous/drg)
 [![Gem Version](https://badge.fury.io/rb/drg.svg)](http://badge.fury.io/rb/drg)
 
-A Ruby utility to help automate dependency management using Bundler. You can pin Gem versions to the current or the next
-available level.
+A suite of rake tasks to help you test and manage your project.
+
+The `drg:pin` suite provides enhanced dependency management with Bundler. You can pin Gem versions to the current or the next
+available minor, major or patch level version. 
+
+The `drg:spec` task generates RSpec scaffolding for existing code. This helps bootstrap your tests and guide you in what 
+[I think] you should be testing.
 
 ## Requirements
 
@@ -20,6 +25,7 @@ gem 'drg'
 ## Tasks
 
 ```bash
+rake drg:spec
 rake drg:pin
 rake drg:pin:major
 rake drg:pin:minor
@@ -30,6 +36,58 @@ rake drg:pin:minor_latest
 rake drg:unpin
 ```
 
+### drg:spec
+
+Generates RSpec scaffolding for existing code. Pass a file or directory and DRG will generate spec files for each:
+
+```bash
+rake drg:spec[app/controllers]
+rake drg:spec[app/models/user.rb]
+```
+
+This task looks at your code's methods and breaks down their conditions into RSpec `context`s. For example:
+
+Given this file:
+
+```ruby
+# app/models/ability.rb
+class Ability
+  include CanCan::Ability
+
+  def initialize(user)
+    if user.admin?
+      can :manage, :all
+    else
+      can :read, :all
+      can :update, User do |u|
+        u.id == user.id
+      end
+    end
+  end
+end
+```
+
+It will generate this spec:
+```ruby
+require "spec_helper"
+
+describe Ability do
+  let(:user) {}
+
+  subject { described_class.new user }
+
+  describe "#initialize" do
+    context "when user.luna?" do
+      before {}
+    end
+
+    context "unless user.luna?" do
+      before {}
+    end
+  end
+end
+```
+
 ### drg:pin
 
 DRG really wants to help you manage your project's gems. But DRG doesn't want to replace Bundler. Instead, we want to build on

data/drg.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = DRG::VERSION
   spec.authors       = ["Ryan Buckley"]
   spec.email         = ["arebuckley@gmail.com"]
-  spec.summary       = %q{DRG that Gemfile! The missing bundler extension}
-  spec.description   = %q{DRG that Gemfile! The missing bundler extension. Gem version automation with Bundler}
+  spec.summary       = %q{A suite of rake tasks to help you test and manage your project}
+  spec.description   = %q{A suite of rake tasks that provide enhanced dependency management and automatic spec generation}
   spec.homepage      = "https://github.com/ridiculous/drg"
   spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   spec.executables   = []
@@ -19,6 +19,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'bundler', '~> 1.10'
   spec.add_dependency 'duck_puncher', '>= 2.0.0', '<= 3.0.0'
   spec.add_dependency 'highline', '~> 1.7'
+  spec.add_dependency 'ruby2ruby', '~> 2.2'
 
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '>= 3.2', '< 4'

data/lib/drg/decorators/sexp_decorator.rb

@@ -0,0 +1,13 @@
+class DRG::Decorators::SexpDecorator < DelegateClass(Sexp)
+  def each_sexp_condition
+    return enum_for(__method__) unless block_given?
+    each_sexp do |exp|
+      next unless exp.is_a?(Sexp)
+      if exp.first == :if
+        yield exp
+      elsif nested_sexp = exp.enum_for(:deep_each).find { |s| s.first == :if }
+        yield nested_sexp
+      end
+    end
+  end
+end

data/lib/drg/decorators.rb

@@ -0,0 +1,3 @@
+module DRG::Decorators
+  autoload :SexpDecorator, 'drg/decorators/sexp_decorator'
+end

data/lib/drg/file_context.rb

@@ -1,5 +1,9 @@
 module DRG
   class FileContext
+    # = Class
+    # First attempt at reading ruby files. It was a pipe dream. See DRG::Ruby for the real stuff ;)
+    #
+
     attr_writer :lines
 
     def initialize

data/lib/drg/ruby/class_func.rb

@@ -0,0 +1,13 @@
+class DRG::Ruby::ClassFunc < DRG::Ruby::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/drg/ruby/condition.rb

@@ -0,0 +1,52 @@
+require 'ruby2ruby'
+
+class DRG::Ruby::Condition
+
+  attr_reader :statement, :nested_conditions, :sexp
+
+  def initialize(sexp)
+    @sexp = sexp
+    @statement = Ruby2Ruby.new.process(sexp.deep_clone)
+    @nested_conditions = Set.new
+    sexp.drop(1).flatten.include?(:if) && sexp.drop(1).deep_each do |exp|
+      DRG::Decorators::SexpDecorator.new(exp).each_sexp_condition do |node|
+        @nested_conditions << self.class.new(node)
+      end
+    end
+    @nested_conditions = @nested_conditions.to_a
+  end
+
+  def short_statement
+    if @statement =~ /(unless|if)(.+)$/
+      ($1 << $2).strip
+    elsif @statement =~ /(.*?)\s+\?\s+/
+      $1.strip
+    end
+  end
+
+  def return_value
+    if @statement =~ /\s+\?\s+(.*?)(:|$)/
+      $1.strip
+    else
+      translate @statement[/(.*?)(unless|if)/, 1].to_s.strip
+    end
+  end
+
+  def translate(txt)
+    txt.sub! /^return\s*/, 'returns '
+    txt.sub! /^returns\s*$/, 'returns nil'
+    txt.strip
+  end
+
+  #
+  # Set related stuff
+  #
+
+  def eql?(other)
+    hash == other.hash
+  end
+
+  def hash
+    sexp.object_id
+  end
+end

data/lib/drg/ruby/const.rb

@@ -1,24 +1,82 @@
 require 'ruby_parser'
 
-module DRG
-  class Ruby
-    class Const
-      CONSTANT_DEFS = [:class, :module, :cdecl]
+class DRG::Ruby::Const
+  CONSTANT_DEFS = { :class => :class, :module => :module, :cdecl => :class }
 
-      def initialize(file)
-        @parser = RubyParser.new.parse File.read(file)
-      end
+  attr_reader :sexp
 
-      def name(sexp = @parser, list = [])
-        sexp = Array(sexp)
-        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.include?(sexp[0])
-          name(sexp.compact[2], list << sexp[1].to_s)
-        end
-        list.join('::')
-      end
+  # @param [Sexp] sexp
+  def initialize(sexp)
+    sexp = sexp.select { |x| x.is_a?(Array) }.last if sexp[0] == :block
+    @sexp = sexp
+  end
+
+  def name(sexp = @sexp, list = [])
+    sexp = Array(sexp)
+    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])
+      name(sexp.compact[2], list << sexp[1].to_s)
+    end
+    list.join('::')
+  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
+
+  def initialization_args
+    funcs.find(-> { OpenStruct.new }) { |func| func.name == :initialize }.args.to_a
+  end
+
+  def func_by_name(name_as_symbol)
+    funcs.find { |x| x.name == name_as_symbol }
+  end
+
+  def funcs
+    @funcs ||= load_funkyness
+  end
+
+  def class?
+    type == :class
+  end
+
+  def module?
+    type == :module
+  end
+
+  # @todo
+  def instance_vars
+  end
+
+  # @todo
+  def class_vars
+  end
+
+  private
+
+  def load_funkyness
+    marked_private = false
+    sexp.map { |node|
+      next unless node.is_a?(Sexp)
+      case node.first
+      when :defn
+        DRG::Ruby::InstanceFunc.new(node, marked_private)
+      when :defs
+        DRG::Ruby::ClassFunc.new(node, marked_private)
+      when :call
+        marked_private ||= node[2] == :private
+        nil
+      else
+        nil
+      end
+    }.compact
   end
 end

data/lib/drg/ruby/func.rb

@@ -0,0 +1,23 @@
+class DRG::Ruby::Func < Struct.new(:sexp, :_private)
+  alias private? _private
+
+  def conditions
+    DRG::Decorators::SexpDecorator.new(sexp).each_sexp_condition.map do |exp|
+      DRG::Ruby::Condition.new(exp)
+    end
+  end
+
+  # @note we drop(1) to get rid of :args (which should be the first item in the sexp)
+  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/drg/ruby/instance_func.rb

@@ -0,0 +1,13 @@
+class DRG::Ruby::InstanceFunc < DRG::Ruby::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/drg/ruby.rb

@@ -1,50 +1,20 @@
 require 'ruby_parser'
+require 'delegate'
 
 module DRG
   class Ruby
-    attr_reader :parser
+    autoload :Const, 'drg/ruby/const'
+    autoload :Condition, 'drg/ruby/condition'
+    autoload :Func, 'drg/ruby/func'
+    autoload :ClassFunc, 'drg/ruby/class_func'
+    autoload :InstanceFunc, 'drg/ruby/instance_func'
 
-    def initialize(file)
-      @parser = RubyParser.new.parse File.read(file)
-    end
-
-    def modules
-    end
-
-    class Klass < Struct.new(:sexp)
-
-      def includes
-      end
-
-      def extends
-      end
-
-      def funcs
-        sexp.find_nodes(:defn) + sexp.find_nodes(:defs)
-      end
-
-      def instance_vars
-      end
+    attr_reader :sexp, :const
 
-      def class_vars
-      end
-    end
-
-    class Func
-      def name
-      end
-
-      def args
-      end
-
-      def private?
-      end
-
-      def conditions
-      end
-    end
-
-    class Condition
+    # @param [Pathname] file
+    def initialize(file)
+      @sexp = RubyParser.new.parse File.read(file)
+      @const = DRG::Ruby::Const.new(sexp)
     end
   end
-end
+end

data/lib/drg/spec.rb

@@ -0,0 +1,85 @@
+class DRG::Spec < DelegateClass(DRG::Ruby::Const)
+  # = Class
+  # generate a rspec file based on existing code
+
+  def self.generate(file)
+    spec = DRG::Spec.new(file)
+    return if spec.funcs.empty? # nothing to do
+    lines = [%Q(require "spec_helper"), %Q(), %Q(describe #{spec.const} do)]
+    if spec.class?
+      spec.initialization_args.each do |arg|
+        lines << %Q(  let(:#{arg}) {})
+      end
+      lines << %Q()
+      lines << %Q(  subject { described_class.new #{spec.initialization_args.join(', ')} })
+    elsif spec.module?
+      lines << %Q(  subject { Class.new { include #{spec.const} }.new })
+    end
+
+    lines << %Q()
+    spec.funcs.reject(&:private?).each do |func|
+      lines << %Q(  describe #{spec.quote("#{func.class? ? '.' : '#'}#{func.name}")} do)
+      func.conditions.each do |condition|
+        lines.concat spec.collect_contexts(condition, '    ')
+      end
+      lines << %Q(  end) << %Q()
+    end
+    lines << %Q(end) << %Q()
+    lines
+  end
+
+  attr_reader :ruby, :file
+
+  def initialize(file)
+    @file = file
+    @ruby = DRG::Ruby.new(file)
+    super @ruby.const
+  end
+
+  def const
+    @const ||= begin
+      require file
+      Kernel.const_get(ruby.const.name)
+    end
+  end
+
+  def collect_contexts(condition, indent = '', contexts = [])
+    new_indent = indent + '  '
+    contexts << %Q(#{indent}context #{quote(tr(condition.short_statement))} do) << %Q(#{new_indent}before {})
+    unless condition.return_value.empty?
+      contexts << %Q(#{new_indent}it #{quote(condition.return_value)} do) << %Q(#{new_indent}end)
+    end
+    if condition.nested_conditions.any?
+      condition.nested_conditions.each { |nc| collect_contexts(nc, new_indent, contexts) }
+    end
+    contexts << %Q(#{indent}end) << %Q() # /context
+    contexts << %Q(#{indent}context #{quote(tr(negate(condition.short_statement)))} do) << %Q(#{new_indent}before {})
+    contexts << %Q(#{indent}end)
+    contexts
+  end
+
+  def quote(txt)
+    txt.strip!
+    if txt =~ /"/
+      "%Q(#{txt})"
+    else
+      %Q("#{txt}")
+    end
+  end
+
+  def negate(phrase)
+    if phrase[/^unless /]
+      phrase.sub /^unless /, 'if '
+    else
+      "not #{phrase}"
+    end
+  end
+
+  def tr(phrase)
+    phrase.sub! /^if /, 'when '
+    phrase.sub! /^not if /, 'unless '
+    phrase.sub! /^if not /, 'unless '
+    phrase.sub! %r"then$", ''
+    phrase
+  end
+end

data/lib/drg/tasks/active_pinner.rb

@@ -101,7 +101,8 @@ module DRG
       # @param [Array] list of a gem version's segments
       # @param [Array] other_list of another gem version's segments
       def higher?(list, other_list)
-        (0..2).to_a.any? { |i| list[i].to_i > other_list[i].to_i }
+        gem_version_segments = (0..2).to_a
+        gem_version_segments.any? { |i| list[i].to_i > other_list[i].to_i }
       end
     end
   end

data/lib/drg/tasks/spec_runner.rb

@@ -0,0 +1,56 @@
+require 'fileutils'
+
+module DRG
+  module Tasks
+    class SpecRunner
+      include Log
+
+      attr_reader :file
+
+      # @param [Pathname] file
+      def initialize(file)
+        @file = Pathname.new(file)
+      end
+
+      def perform
+        fail ArgumentError, %Q(File or directory does not exist: "#{file}") if !File.exists?(file) && !File.exists?("#{file}.rb")
+        ruby_files.each do |ruby_file|
+          file_path = Pathname.new(File.expand_path(ruby_file))
+          spec = DRG::Spec.generate(file_path)
+          next unless spec
+          rspec_file = Pathname.new(spec_file(ruby_file))
+          log "Generating #{rspec_file}"
+          FileUtils.mkdir_p(rspec_file.parent)
+          File.open(spec_file(ruby_file), 'wb') do |f|
+            f << spec.join("\n")
+          end
+        end
+      end
+
+      def ruby_files
+        if File.directory?(file)
+          Dir[File.join(file, '**', '*.rb')]
+        else
+          if file.extname.empty?
+            ["#{file}.rb"]
+          else
+            [file]
+          end
+        end
+      end
+
+      # @note subbing out /app/ is Rails specific
+      def spec_file(ruby_file)
+        File.join(spec_path, "#{ruby_file.sub('.rb', '_spec.rb')}").sub '/app/', '/'
+      end
+
+      def spec_path
+        if File.directory?(File.expand_path('spec'))
+          File.expand_path('spec')
+        else
+          fail "Couldn't find spec directory"
+        end
+      end
+    end
+  end
+end

data/lib/drg/tasks.rb

@@ -0,0 +1,11 @@
+module DRG
+  module Tasks
+    autoload :Updater, 'drg/tasks/updater'
+    autoload :Pinner, 'drg/tasks/pinner'
+    autoload :ActivePinner, 'drg/tasks/active_pinner'
+    autoload :Gemfile, 'drg/tasks/gemfile'
+    autoload :GemfileLine, 'drg/tasks/gemfile_line'
+    autoload :Log, 'drg/tasks/log'
+    autoload :SpecRunner, 'drg/tasks/spec_runner'
+  end
+end

data/lib/drg/version.rb

@@ -1,3 +1,3 @@
 module DRG
-  VERSION = '0.13.1'.freeze
+  VERSION = '0.14.0'.freeze
 end

data/lib/drg.rb

@@ -1,27 +1,19 @@
+require 'pathname'
 require 'ostruct'
 require 'set'
 require 'bundler'
 require 'duck_puncher'
 require 'highline/import'
-
-# defines Object#clone!
-DuckPuncher.punch! :Object
-
 require 'drg/version'
 
 module DRG
-  module Tasks
-    autoload :Updater, 'drg/tasks/updater'
-    autoload :Pinner, 'drg/tasks/pinner'
-    autoload :ActivePinner, 'drg/tasks/active_pinner'
-    autoload :Gemfile, 'drg/tasks/gemfile'
-    autoload :GemfileLine, 'drg/tasks/gemfile_line'
-    autoload :Log, 'drg/tasks/log'
-  end
+  # defines Object#clone! which provides a deep clone
+  DuckPuncher.punch! :Object
 
-  class Ruby
-    autoload :Const, 'drg/ruby/const'
-  end
+  autoload :Tasks, 'drg/tasks'
+  autoload :Ruby, 'drg/ruby'
+  autoload :Decorators, 'drg/decorators'
+  autoload :Spec, 'drg/spec'
 end
 
 load 'tasks/drg.rake'

data/lib/tasks/drg.rake

@@ -46,4 +46,13 @@ namespace :drg do
     task latest_minor: :minor_latest
     task latest_patch: :patch_latest
   end
+
+  task :spec, [:file_name] => :environment do |_, args|
+    DRG::Tasks::SpecRunner.new(args.file_name).perform
+  end
+
+  unless defined?(Rails)
+    task :environment do
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: drg
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.14.0
 platform: ruby
 authors:
 - Ryan Buckley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-03 00:00:00.000000000 Z
+date: 2015-11-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ruby_parser
@@ -78,6 +78,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.7'
+- !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'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -112,8 +126,8 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '4'
-description: DRG that Gemfile! The missing bundler extension. Gem version automation
-  with Bundler
+description: A suite of rake tasks that provide enhanced dependency management and
+  automatic spec generation
 email:
 - arebuckley@gmail.com
 executables: []
@@ -131,18 +145,27 @@ files:
 - bin/setup
 - drg.gemspec
 - lib/drg.rb
+- lib/drg/decorators.rb
+- lib/drg/decorators/sexp_decorator.rb
 - lib/drg/file_context.rb
 - lib/drg/file_reader.rb
 - lib/drg/judge.rb
 - lib/drg/let.rb
 - lib/drg/ruby.rb
+- lib/drg/ruby/class_func.rb
+- lib/drg/ruby/condition.rb
 - lib/drg/ruby/const.rb
+- lib/drg/ruby/func.rb
+- lib/drg/ruby/instance_func.rb
 - lib/drg/scanner.rb
+- lib/drg/spec.rb
+- lib/drg/tasks.rb
 - lib/drg/tasks/active_pinner.rb
 - lib/drg/tasks/gemfile.rb
 - lib/drg/tasks/gemfile_line.rb
 - lib/drg/tasks/log.rb
 - lib/drg/tasks/pinner.rb
+- lib/drg/tasks/spec_runner.rb
 - lib/drg/tasks/updater.rb
 - lib/drg/version.rb
 - lib/tasks/drg.rake
@@ -168,5 +191,5 @@ rubyforge_project:
 rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
-summary: DRG that Gemfile! The missing bundler extension
+summary: A suite of rake tasks to help you test and manage your project
 test_files: []