clairvoyant 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e6b1d12fb5093c1e52b52d28d35f0e82844cb5a8
-  data.tar.gz: 8eb2d246196c422555d4c72f0662d566eff12779
+  metadata.gz: 2a318ff0f912c23bd9f489aedaf96fccdd3340f4
+  data.tar.gz: a87c1748b49afee8c2a829bed91590211198336d
 SHA512:
-  metadata.gz: 2383a4985918c51e7fa7d0ac7f31e6f37ca5d8685ec126664bd2ee4eb17cd550169f21772ca24fa787830c69b1b71aa6e74a6fa3fa305c711ac879ba4f595ba9
-  data.tar.gz: c3504330ca0dc2eafab5685604063e4db7b21d58390198126fa26a9eb397327aaf47c803def2e004942b016cf08b985b87c3ffdd3b96930a570e8243b257d9f1
+  metadata.gz: 7790fd8f1fe37b8dce32f487eedced7736d322993025777461c1d815434e81bc8abf4a256e99ac27bfa9af162971440d1bdc99e0a4c70783eb9d47487d213a7e
+  data.tar.gz: b5050a033bf01a1ce43b1f18a03547adcdd79cc63d4a8949b541dc72db35c4ebfd9d1efa177b2c625761b74095bf28dba29090cba236f33c83d08e0da20c66ed

data/README.md

@@ -1,28 +1,72 @@
 # Clairvoyant
 
-TODO: Write a gem description
+## SUPER ALPHA
 
-## Installation
+This is not meant to be used for anything serious at this point. It will at least give you a skeleton for your
+code but not much beyond that at this point. You've been warned.
 
-Add this line to your application's Gemfile:
+## What is it? (Theoretical)
 
-    gem 'clairvoyant'
+Divine what code should be written to make a suite of tests pass.
 
-And then execute:
+Test code is extremely close to actual code, and a lot of inferences can be made about the nature of the code that would be generated in order to fulfil the tests.
 
-    $ bundle
+By parsing RSPEC with a secondary DSL, we can formulate an Abstract Syntax Tree from the tests that can be reasonably mapped to working Ruby code.
 
-Or install it yourself as:
+## Abstract
 
-    $ gem install clairvoyant
+```
+describe Person do
+  let(:person) { Person.new('brandon', 23) }
+
+  describe '#name' do
+    expect(person.name).to eq('brandon')
+  end
+
+  describe '#age' do
+    expect(person.age).to eq(23)
+  end
+end
+```
+
+...would map to the AST:
+```ruby
+{
+  person: {
+    name: string,
+    age: integer
+  }
+}
+```
+
+...and can be converted to:
+```ruby
+class Person
+  attr_accessor :name, :age
+
+  def initialize(name, age)
+    @name = name
+    @age  = age
+  end
+end
+```
+
+This is merely an abstract and requires a lot of work though.
 
 ## Usage
 
-TODO: Write usage instructions here
+Currently it will only work with very basic RSPEC files. This will be tested against later.
+
+```ruby
+builder = Clairvoyant.grok('path/to/rspec/file.rb')
+
+# And there's your class!
+puts builder
+```
 
 ## Contributing
 
-1. Fork it ( http://github.com/<my-github-username>/clairvoyant/fork )
+1. Fork it ( http://github.com/baweaver/clairvoyant/fork )
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)

data/lib/clairvoyant.rb

@@ -1,5 +1,49 @@
 require "clairvoyant/version"
 
+require 'clairvoyant/indentable'
+
+require 'clairvoyant/builder'
+require 'clairvoyant/method'
+
 module Clairvoyant
-  # Your code goes here...
+  class << self
+    # RSPEC describe parser
+    #
+    # @param description [String] - What we're describing
+    #
+    # @return [type] [description]
+    def describe(description, &block)
+      @builder.klass_name ||= description if description.is_a?(Symbol)
+      @builder.add_method(description)    if description[0] == '#'
+      block.call rescue nil
+    end
+
+    # Catch missing constants so we don't hav obscure rescues throughout the
+    # code
+    #
+    # @param name [Symbol] - Name of the undefined constant that was caught
+    #
+    # @return [Symbol]
+    def const_missing(name)
+      name
+    end
+
+    # Parses a file into a builder
+    #
+    # @param file_name [String] - Path to the file
+    #
+    # @return [Clairvoyant::Builder]
+    def grok(file_name)
+      cleaned_lines =
+        File
+          .open(file_name, 'r')
+          .drop_while { |line| !line.include?('describe') }.join("\n")
+
+      @builder = Clairvoyant::Builder.new
+
+      self.class_eval cleaned_lines
+
+      @builder
+    end
+  end
 end

data/lib/clairvoyant/builder.rb

@@ -0,0 +1,61 @@
+module Clairvoyant
+  # Used to build up Clairvoyant generated classes
+  #
+  # @author [lemur]
+  class Builder
+    include Indentable
+
+    attr_accessor :klass_name
+
+    def initialize(klass_name: nil, indent_size: 2)
+      @klass_name    = klass_name
+      @indent_size   = indent_size
+      @klass_methods = []
+    end
+
+    # Used to format the klass.
+    #
+    # @note I don't like the way this is written, clean later
+    #
+    # @return [Proc]
+    def klass
+      -> method_string {
+        "class #{@klass_name}\n" << method_string.rstrip << "\nend"
+      }
+    end
+
+    # Adds a method to the builder
+    #
+    # @param name [String] - Name of the method
+    #
+    # @return [Array[Clairvoyant::Method]] - Current methods
+    def add_method(name)
+      @klass_methods << Method.new(name: name[1..-1])
+    end
+
+    # Composes a Ruby Class from the builder
+    #
+    # @return [String] - Saveable and Runnable Ruby Class
+    def compose_klass
+      klass.call @klass_methods.reduce('') { |method_string, method|
+        method_string << "#{method}\n\n"
+      }
+    end
+
+    # Alias for compose_klass
+    #
+    # @return [String]
+    def to_s
+      compose_klass
+    end
+
+    # Saves the generated class as a file
+    #
+    # @param path [String] - Where to save
+    #
+    # @return [Unit]
+    def save_as(path)
+      File.open(path, 'w') { |file| file << compose_klass }
+    end
+  end
+end

data/lib/clairvoyant/indentable.rb

@@ -0,0 +1,12 @@
+module Clairvoyant
+  module Indentable
+    # Generates spacing for indentation
+    #
+    # @param times = 1 [Integer] - Number of indents to render
+    #
+    # @return [String]
+    def indent(times = 1)
+      ' ' * (@indentation * times)
+    end
+  end
+end

data/lib/clairvoyant/method.rb

@@ -0,0 +1,21 @@
+module Clairvoyant
+  class Method
+    include Indentable
+
+    attr_reader :name
+
+    def initialize(name:, indentation: 2)
+      @name        = name
+      @indentation = indentation
+    end
+
+    # Formats a method as a ruby method
+    #
+    # @return [String]
+    def to_s
+      "#{indent(1)}def #{name}\n" <<
+        "#{indent(2)}# Code here later\n" <<
+      "#{indent(1)}end"
+    end
+  end
+end

data/lib/clairvoyant/version.rb

@@ -1,3 +1,3 @@
 module Clairvoyant
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/spec/fixtures/basic_rspec.rb

@@ -0,0 +1,9 @@
+describe Foo do
+  describe '#bar' do
+    1
+  end
+
+  describe '#baz' do
+    5
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: clairvoyant
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Brandon Weaver
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-11 00:00:00.000000000 Z
+date: 2015-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Attempts to divine what code will make tests pass
@@ -45,14 +45,18 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - clairvoyant.gemspec
 - lib/clairvoyant.rb
+- lib/clairvoyant/builder.rb
+- lib/clairvoyant/indentable.rb
+- lib/clairvoyant/method.rb
 - lib/clairvoyant/version.rb
+- spec/fixtures/basic_rspec.rb
 homepage: https://www.github.com/baweaver/clairvoyant
 licenses:
 - MIT
@@ -63,19 +67,19 @@ 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.2.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Predict code to be written from RSPEC
-test_files: []
-has_rdoc: 
+test_files:
+- spec/fixtures/basic_rspec.rb