codeshift 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6af6f02701bdb6430dd72cfc5dbd43b0e0e16c7382905d0c951c13366d60acde
-  data.tar.gz: 500607afbfeea607ca65d5c95eb3030c6a37adbf8bb22092a6e06ce6a68b1d63
+  metadata.gz: 3b5b1f7425f32b67e65b8ce7b0b2e22061495570b95600d8c6114b8a86ebbedd
+  data.tar.gz: 055d30acead1d71b2af0c0e9895adcf2cc64c13e600548b713bd108831fb3b23
 SHA512:
-  metadata.gz: 8e0613d86f951f5c664f9fa092b6c1f7c5a49e05fbe5b8c0aa58f1f67a1a10fd6df80359b94db2ecb293c601d467586b8c862d998d3f08749cf33e0bc171d4af
-  data.tar.gz: 43593a3b6f35c47ba04c810ce86124723d18500c0b4b60644996bc6800361415ad7feecf785989e4e395e88a48db62b046fe1fb0d4c8db5d2c59abd6eb9a3bcf
+  metadata.gz: 77e1cdb4e9a99b634acbe0feeb5f6286ae439ed401f0df13a234f628def50a03900bd4eabb644fd879451b67fa1466cd3dd8520aedeb55aa57601ec12f9bb848
+  data.tar.gz: 847fd2a32bb79bcefdc3df64c5d0c1914f368ebe72ccf13f51f840d347bea43aa9decbe1e048330894d424e50c8fb0dbe37c7d57578696676ec08ba9f5f5b0ff

data/README.md

@@ -1,28 +1,80 @@
 # Codeshift
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/codeshift`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+A Ruby codemod CLI to transform your source code using AST(Abstract Syntax Trees) and the [parser](https://github.com/whitequark/parser) gem. It is typically used on ruby codebase like RAILS applications and other stuff.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+```sh
+$ gem install codeshift
+```
+
+
+## Usage
+This tool requires a `transform.rb` file which contains the transform logic to be 
+applied on the source files in a folder.
+
+```sh
+$ codeshift -t [TRANSFORM FILE] [PATHS]
+```
+
+To apply the transform logic on your `app/models` files
+
+```sh
+$ codeshift -t transform.rb app/models/**/*.rb
+```
+
+For example if you want to reverse the local variable names and method names in your code
+you will be doing something like this:
 
+Create a new ruby file with the tranformation logic to be applied on the
+AST of the source code. For writing transforms you can make use of the 
+[Ruby AST Explorer](https://ruby-ast-explorer.herokuapp.com/)
+
+### transform.rb
 ```ruby
-gem 'codeshift'
+# Your Transform Class should always extend from 
+# Parser:: TreeRewriter
+class Transform < Parser::TreeRewriter
+  def on_lvasgn(node)
+    # Reverse the variable names
+    replace(node.loc.to_hash[:name], node.children[0].to_s.reverse)
+  end
+
+  def on_def(node)
+    replace(node.loc.to_hash[:name], node.children[0].to_s.reverse)
+  end
+end
+
 ```
 
-And then execute:
+If your source code looks like below in a folder called `~/Desktop/test/ruby`
 
-    $ bundle
+### sample.rb
+```ruby
+tips = ["hello", "world"]
+def print_tips
+  tips.each { |key, value| print "Tip #{key}: #{value}" }
+end
+```
 
-Or install it yourself as:
+Then use it against your source code
 
-    $ gem install codeshift
+```sh
+$ codeshift -t transform.rb ~/Desktop/test/ruby/**/*.rb
+```
+
+Then your source will be transformed something like:
+
+### sample.rb
+```ruby
+spit = ["hello", "world"]
+def spit_tnirp
+  tips.each { |key, value| print "Tip #{key}: #{value}" }
+end
+
+```
 
-## Usage
 
-TODO: Write usage instructions here
 
 ## Development
 

data/lib/codeshift/codeshift_options.rb

@@ -0,0 +1,13 @@
+module Codeshift
+  class CodeshiftOptions
+    attr_accessor :file_path
+    attr_accessor :transform
+
+    def initialize
+      @file_path = nil
+      @transform = "./transform.rb"
+    end
+
+
+  end
+end

data/lib/codeshift/codeshift_transformer.rb

@@ -0,0 +1,23 @@
+require 'parser/current'
+
+module Codeshift
+  class CodeshiftTransformer
+    def initialize(code, transform)
+      @code = code
+      @transform = transform
+    end
+
+    def transform
+      eval(@transform)
+
+      buffer        = Parser::Source::Buffer.new('(example)')
+      buffer.source = @code
+      temp = Parser::CurrentRuby.parse(@code)
+      rewriter      = Transform.new
+
+      # Rewrite the AST, returns a String with the new form.
+      output =  rewriter.rewrite(buffer, temp)
+
+    end
+  end
+end

data/lib/codeshift/version.rb

@@ -1,3 +1,3 @@
 module Codeshift
-  VERSION = "0.1.2"
+  VERSION = "0.1.3"
 end

data/lib/codeshift.rb

@@ -1,6 +1,3 @@
 require "codeshift/version"
-
-module Codeshift
-  class Error < StandardError; end
-  # Your code goes here...
-end
+require "codeshift/codeshift_options"
+require "codeshift/codeshift_transformer"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: codeshift
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Rajasegar Chandran
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-25 00:00:00.000000000 Z
+date: 2019-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -76,6 +76,8 @@ files:
 - exe/codeshift
 - lib/codeshift.rb
 - lib/codeshift/cli.rb
+- lib/codeshift/codeshift_options.rb
+- lib/codeshift/codeshift_transformer.rb
 - lib/codeshift/version.rb
 homepage: https://github.com/rajasegar/codeshift
 licenses: