zapata 0.0.1

data/lib/zapata/rzpec/writer.rb

@@ -0,0 +1,115 @@
+module Zapata
+  module RZpec
+    class Writer
+      class << self
+        attr_accessor :ivars
+
+        def reset_ivars
+          @ivars = []
+        end
+      end
+
+      def initialize(file, code, subject_analysis, whole_analysis, spec_analysis = nil)
+        self.class.reset_ivars
+        @subject_analysis = subject_analysis
+        @whole_analysis = whole_analysis
+        @spec_analysis = spec_analysis
+        @writer = Core::Writer.new(file)
+        @result = {}
+
+        write_require
+
+        klasses.each do |klass|
+          write_class(klass)
+        end
+
+        self.class.reset_ivars
+      end
+
+      def write_require
+        @writer.append_line("require '#{Core::Loader.helper_name}'")
+      end
+
+      def klasses
+        @subject_analysis.select { |obj| obj.is_a?(Primitive::Klass) }
+      end
+
+      def klass_defs(klass)
+        @subject_analysis.select do |method|
+          [Primitive::Def, Primitive::Defs].include?(method.class) and
+            method.public? and method.klass.name == klass.name
+        end
+      end
+
+      def initialize_def(klass)
+        klass_defs(klass).detect { |method| method.name == :initialize }
+      end
+
+      def write_class(klass)
+        @writer.append_line
+        @writer.append_line("describe #{klass.name} do")
+
+        write_instance_let(klass)
+
+        klass_defs(klass).each do |primitive_def|
+          write_method(primitive_def)
+        end
+
+        self.class.ivars.each do |ivar|
+          predicted_value = Predictor::Args.choose_value(ivar.value, ivar)
+          literal_predicted_value = Printer.print(predicted_value.to_raw)
+          write_let(ivar.value, literal_predicted_value)
+        end
+
+        @writer.append_line('end')
+      end
+
+      def write_instance_let(klass)
+        if initialize_def = initialize_def(klass)
+          write_let_from_initialize(initialize_def)
+        else
+          write_let(klass.name, "#{klass.name}.new")
+        end
+      end
+
+      def write_let(name, block)
+        @writer.append_line("let(:#{Printer.to_var_name(name)}) do")
+        @writer.append_line(block)
+        @writer.append_line('end')
+      end
+
+      def write_let_from_initialize(initialize_def)
+        block = "#{initialize_def.klass.name}.new#{initialize_def.literal_predicted_args}"
+        write_let(initialize_def.klass.name, block)
+      end
+
+      def write_method(primitive_def)
+        return unless primitive_def.node.body
+        return if primitive_def.name == :initialize
+
+        @writer.append_line
+        @writer.append_line("it '##{primitive_def.name}' do")
+
+        receiver = if primitive_def.self?
+          primitive_def.klass.name
+        else
+          Printer.to_var_name(primitive_def.klass.name)
+        end
+
+        @writer.append_line(
+          "expect(#{receiver}.#{primitive_def.name}#{primitive_def.literal_predicted_args}).to eq(#{write_equal(primitive_def.name)})"
+        )
+
+        @writer.append_line('end')
+      end
+
+      def write_equal(method_name)
+        if @spec_analysis
+          Printer.print(Primitive::Raw.new(:literal, @spec_analysis.expected(method_name)))
+        else
+          Printer.print(Primitive::Raw.new(:str, 'Fill this in by hand'))
+        end
+      end
+    end
+  end
+end

data/lib/zapata/version.rb

@@ -0,0 +1,3 @@
+module Zapata
+  VERSION = "0.0.1"
+end

data/spec/array_spec.rb

@@ -0,0 +1,37 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  before(:all) do
+    @generated = exec_generation('app/models/test_array.rb')
+  end
+
+  it '#test_in_arg' do
+    has_block('#test_in_arg', %Q{
+      expect(test_array.test_in_arg([2, 7.1, 8])).to eq([2, 7.1, 8])
+    })
+  end
+
+  it '#test_nested_one_level' do
+    has_block('#test_nested_one_level', %Q{
+      expect(test_array.test_nested_one_level([[2, 7.1, 8], :mexico])).to eq([[2, 7.1, 8], :mexico])
+    })
+  end
+
+  it '#test_nested_two_levels' do
+    has_block('#test_nested_two_levels', %Q{
+      expect(test_array.test_nested_two_levels([[[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico])).to eq([[[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico])
+    })
+  end
+
+  it '#test_nested_three_levels' do
+    has_block('#test_nested_three_levels', %Q{
+      expect(test_array.test_nested_three_levels([[[[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico], [[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico])).to eq([[[[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico], [[2, 7.1, 8], :mexico], [2, 7.1, 8], :mexico])
+    })
+  end
+
+  it '#test_hash_nested' do
+    has_block('#test_hash_nested', %Q{
+      expect(test_array.test_hash_nested([{ emiliano: [2, 7.1, 8] }])).to eq([{ emiliano: [2, 7.1, 8] }])
+    })
+  end
+end

data/spec/definition_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  before(:all) do
+    @generated = exec_generation('app/models/test_definition.rb')
+  end
+
+  it '#in_optional_args' do
+    has_block('#in_optional_args', %Q{
+      expect(test_definition.in_optional_args(:audioslave)).to eq(:audioslave)
+    })
+  end
+
+  it '#use_optional' do
+    has_block('#use_optional', %Q{
+      expect(test_definition.use_optional(:audioslave)).to eq(:audioslave)
+    })
+  end
+
+  it '#var_in_optional_args' do
+    has_block('#var_in_optional_args', %Q{
+      expect(test_definition.var_in_optional_args('Chuck')).to eq('Chuck')
+    })
+  end
+
+  it '#method_in_optional_args' do
+    has_block('#method_in_optional_args', %Q{
+      expect(test_definition.method_in_optional_args('I am falling')).to eq('I am falling')
+    })
+  end
+
+  it '#call_method_result_in_optional_args' do
+    has_block('#call_method_result_in_optional_args', %Q{
+      expect(test_definition.call_method_result_in_optional_args('Missing "complex_method"')).to eq('Missing "complex_method"')
+    })
+  end
+
+  it '#resursive_method' do
+    has_block('#recursive_method', %Q{
+      expect(test_definition.recursive_method).to eq('Exception in RSpec')
+    })
+  end
+end

data/spec/hash_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  before(:all) do
+    @generated = exec_generation('app/models/test_hash.rb')
+  end
+
+  it '#test_in_arg' do
+    has_block('#test_in_arg', %Q{
+      expect(test_hash.test_in_arg({ 1 => :one, TestHash => 2.718 })).to eq({ 1 => :one, TestHash => 2.718 })
+    })
+  end
+
+  it '#test_nested_one_level' do
+    has_block('#test_nested_one_level', %Q{
+      expect(test_hash.test_nested_one_level({ first_level: { 1 => :one, TestHash => 2.718 } })).to eq({ first_level: { 1 => :one, TestHash => 2.718 } })
+    })
+  end
+
+  it '#test_nested_two_levels' do
+    has_block('#test_nested_two_levels', %Q{
+      expect(test_hash.test_nested_two_levels({ second_level: { first_level: { 1 => :one, TestHash => 2.718 } } })).to eq({ second_level: { first_level: { 1 => :one, TestHash => 2.718 } } })
+    })
+  end
+
+  it '#test_nested_three_levels' do
+    has_block('#test_nested_three_levels', %Q{
+      expect(test_hash.test_nested_three_levels({ third_level: { second_level: { first_level: { 1 => :one, TestHash => 2.718 } } } })).to eq({ third_level: { second_level: { first_level: { 1 => :one, TestHash => 2.718 } } } })
+    })
+  end
+
+  it '#test_key_as_another_hash' do
+    has_block('#test_key_as_another_hash', %Q{
+      expect(test_hash.test_key_as_another_hash({ { 1 => :one, TestHash => 2.718 } => :ratm })).to eq({ { 1 => :one, TestHash => 2.718 } => :ratm })
+    })
+  end
+
+  it '#test_keys_are_symbols' do
+    has_block('#test_keys_are_symbols', %Q{
+      expect(test_hash.test_keys_are_symbols({ this: 'should', be: 'pretty' })).to eq({ this: 'should', be: 'pretty' })
+    })
+  end
+end

data/spec/klass_types_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  context 'it should work with' do
+    it 'bare module' do
+      generated = exec_generation('app/models/testing_module/bare.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestingModule::Bare do
+        let(:bare) do
+          TestingModule::Bare.new
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    it 'nested module' do
+      generated = exec_generation('app/models/testing_module/nested/inside.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestingModule::Nested::Inside do
+        let(:inside) do
+          TestingModule::Nested::Inside.new
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    context 'klass methods' do
+      before(:all) do
+        @generated = exec_generation('app/models/testing_module/klass_methods.rb')
+      end
+
+      it '#defined_with_self' do
+        has_block('#defined_with_self', %Q{
+          expect(TestingModule::KlassMethods.defined_with_self(5)).to eq(5)
+        })
+      end
+
+      it '#defined_with_back_back_self' do
+        has_block('#defined_with_back_back_self', %Q{
+          expect(TestingModule::KlassMethods.defined_with_back_back_self(5)).to eq(5)
+        })
+      end
+
+      it '#back_to_public_defined_with_self' do
+        has_block('#back_to_public_defined_with_self', %Q{
+          expect(TestingModule::KlassMethods.back_to_public_defined_with_self(5)).to eq(5)
+        })
+      end
+    end
+  end
+end

data/spec/send_spec.rb

@@ -0,0 +1,31 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  before(:all) do
+    @generated = exec_generation('app/models/test_send.rb')
+  end
+
+  it '#another_method_as_arg' do
+    has_block('#another_method_as_arg', %Q{
+      expect(test_send.another_method_as_arg('Help method')).to eq('Help method')
+    })
+  end
+
+  it '#second_level_method_chain' do
+    has_block('#second_level_method_chain', %Q{
+      expect(test_send.second_level_method_chain('Help method')).to eq('Help method')
+    })
+  end
+
+  it '#third_level_method_chain' do
+    has_block('#third_level_method_chain', %Q{
+      expect(test_send.third_level_method_chain('Help method')).to eq('Help method')
+    })
+  end
+
+  it '#method_with_calculated_value' do
+    has_block('#method_with_calculated_value', %Q{
+      expect(test_send.method_with_calculated_value('Missing "calculated_value"')).to eq('Missing "calculated_value"')
+    })
+  end
+end

data/spec/simple_types_spec.rb

@@ -0,0 +1,90 @@
+require 'spec_helper'
+
+describe Zapata::Revolutionist do
+  context 'it should work with' do
+    it 'ints' do
+      generated = exec_generation('app/models/test_int.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestInt do
+        let(:test_int) do
+          TestInt.new
+        end
+
+        it '#test_int_in_arg' do
+          expect(test_int.test_int_in_arg(1)).to eq(1)
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    it 'symbols' do
+      generated = exec_generation('app/models/test_sym.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestSym do
+        let(:test_sym) do
+          TestSym.new
+        end
+
+        it '#test_sym_in_arg' do
+          expect(test_sym.test_sym_in_arg(:rock)).to eq(:rock)
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    it 'strings' do
+      generated = exec_generation('app/models/test_str.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestStr do
+        let(:test_str) do
+          TestStr.new
+        end
+
+        it '#test_str_in_arg' do
+          expect(test_str.test_str_in_arg('audioslave')).to eq('audioslave')
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    it 'floats' do
+      generated = exec_generation('app/models/test_float.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestFloat do
+        let(:test_float) do
+          TestFloat.new
+        end
+
+        it '#test_float_in_arg' do
+          expect(test_float.test_float_in_arg(2.718)).to eq(2.718)
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+
+    it 'consts' do
+      generated = exec_generation('app/models/test_const.rb')
+      expected = expected(%Q{require 'rails_helper'
+
+      describe TestConst do
+        let(:test_const) do
+          TestConst.new
+        end
+
+        it '#test_const_in_arg' do
+          expect(test_const.test_const_in_arg(TestConst)).to eq(TestConst)
+        end
+      end})
+
+      expect(generated).to eq(expected)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,124 @@
+require 'zapata'
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, make a
+# separate helper file that requires this one and then use it only in the specs
+# that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  # The settings below are suggested to provide a good initial experience
+  # with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+    expectations.syntax = :expect
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Enable only the newer, non-monkey-patching expect syntax.
+    # For more details, see:
+    #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+    mocks.syntax = :expect
+
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended.
+    mocks.verify_partial_doubles = true
+  end
+=end
+end
+
+# Helper methods
+RAILS_TEST_APP_DIR = "#{Dir.pwd}/spec/support/rails_test_app"
+
+def clean(string)
+  string.split(/\n/).map(&:strip).join("\n")
+end
+
+def expected(code)
+  clean(
+    <<-EXPECTED
+      #{code}
+    EXPECTED
+  )
+end
+
+def exec_generation(generate_for)
+  stdin, stdout, stderr = Bundler.with_clean_env do
+    Open3.popen3(
+      "cd #{RAILS_TEST_APP_DIR} && bundle exec zapata generate #{generate_for}"
+    )
+  end
+
+  output = stdout.readlines
+  generated_filename = output.last.match(/File\ (.+)\ was/)[1]
+  spec_path = "#{RAILS_TEST_APP_DIR}/#{generated_filename}"
+
+  clean(
+    <<-ACTUAL
+      #{File.read(spec_path)}
+    ACTUAL
+  )
+end
+
+def has_block(name, expected_content)
+  generated_lines = @generated.split("\n")
+  it_starts = generated_lines.index { |line| line == "it '#{name}' do" }
+  raise 'No such block' unless it_starts
+
+  might_match_lines = generated_lines[it_starts..-1]
+  it_ends = might_match_lines.index { |line| line == 'end' }
+
+  block = might_match_lines[1...it_ends].first
+  expect(block).to eq(expected_content.strip)
+end