rails_zen 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ffdf4939e8dda4d2ca2dca549392f46b0a417a3a
+  data.tar.gz: 33d799f39f4be8726d9ba7b4f7da2a8b6a35acc7
+SHA512:
+  metadata.gz: 4d845aade057e447bb8860e6179286e9628ec4b8e3194ff59690ca08774a6d504640d109297a5d5a67f012e4719750ef1b9576a2674477cfeaf4b1e2994c7d88
+  data.tar.gz: 2d67d68126efc3db3158436f616e16917e1ed2b57f47fe17473eedfe946c0e62adcc7383555d6f0f4741a3e4f62c7f946498945e84ac5564e62ece24e0afb9f5

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/bin/rspec
+/bin/cucumber
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails_zen.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Vysakh Sreenivasan
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,102 @@
+# RailsZen
+
+**AIM**: To save time by giving a boilerplate, and a thought flow.
+
+A step by step generator. This will get *uniqueness*, *validations*  from you, and write
+the appropriate files (model, migration, model_spec).
+
+The specs generated here assumes you are using
+
+- Rspec (>3.0)
+- Shoulda matchers
+- FactoryGirl
+
+*NOTE*: You need to use this app at the root of your rails directory
+
+*Disclamier*: Things like mocks, stubs and proper testing might not be possible with this project.
+The aim is to automate as many things as possible, this is not a panacea :) .
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_zen'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails_zen
+
+## Usage
+
+### COMMANDS
+
+####  model g (generate)
+
+    rails_zen model g user name:string score:integer
+
+- Once you enter this command, you will have few questions asked such as what to validate, which attribute is unique.
+- Based on your input, the model, model_spec and migration files will be written
+
+#### model act (action)
+
+    rails_zen model act calculator sum
+
+- When you want to add a method to your model, you could invoke this command.
+
+- This will get inputs from you such as:
+    - what the method does
+    - the argument names
+    - sample argument with a corresponding output
+
+- Based on these input, a skeleton method will be written to your model file and model spec file
+
+*OPTIONS*: If you want to write a class method you can pass --class option like this
+
+
+    rails_zen model g calculator sum --class
+
+#### Use help to see the examples
+
+    rails_zen model g help
+    rails_zen model act help
+
+You could see this sample video demonstrating the usage of the gem.
+
+[![Rails_zen](https://i.ytimg.com/vi/rXphSHFXT1M/0.jpg)](http://youtu.be/rXphSHFXT1M)
+
+### Tip
+
+- Create aliases for these commands in your bashrc or zshrc.
+- I'm using
+
+    alias rzmg="rails_zen model g "
+    alias rzma="rails_zen model act "
+
+```bash
+rzmg user name:string score:integer
+rzma user calculate_score
+```
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rails_zen/fork )
+
+    bundle binstub rspec-core
+    bundle binstub cucumber
+
+    bin/rspec
+    bin/cucumber
+
+- This project uses [thor](https://github.com/erikhuda/thor/). You could [refer this blog post](willschenk.com/making-a-command-line-utility-with-gems-and-thor/) to get a quick idea.
+- To read the source code, start with `lib/cli.rb` & `bin/rails_zen`
+
+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`)
+5. Please write unit test using rspec and integeration spec using aruba/cucumber.
+6. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec
+

data/bin/rails_zen

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rails_zen'
+RailsZen::Dexterity.start( ARGV )

data/features/model/act.feature

@@ -0,0 +1,49 @@
+Feature: Create a function & related spec for the model
+
+    Scenario: Enters the command with arguments
+        When I run `rails_zen model act calculator sum` interactively
+        When I close the stdin stream
+        Then the output should contain "What does your method do?"
+
+    Scenario: Enters what the method does
+        When I run `rails_zen model act calculator sum` interactively
+        And I type "returns sum of two numbers"
+        #And I type "a,b"
+        #And I type "1,2"
+        #And I type "3"
+        When I close the stdin stream
+        Then the output should contain "What name would you give your arguments"
+
+    Scenario: Enters the argument names
+        When I run `rails_zen model act calculator sum` interactively
+        And I type "returns sum of two numbers"
+        And I type "a,b"
+        #And I type "1,2"
+        #And I type "3"
+        When I close the stdin stream
+        Then the output should contain "Give example arguments"
+
+    Scenario: Enters the argument values
+        When I run `rails_zen model act calculator sum` interactively
+        And I type "returns sum of two numbers"
+        And I type "a,b"
+        And I type "1,2"
+        #And I type "3"
+        When I close the stdin stream
+        Then the output should contain "Enter the expected output for the previously entered arguments. eg: 3"
+
+    Scenario: Enters no arguments
+        When I run `rails_zen model act greet hello` interactively
+        And I type "says hello"
+        And I type ""
+        When I close the stdin stream
+        Then the output should not contain "Give example arguments"
+
+        #@focus
+        #Scenario: Enters the end result
+        #When I run `rails_zen model act user sum` interactively
+        #And I type "returns sum of two numbers"
+        #And I type "a,b"
+        #And I type "1,2"
+        #And I type "3"
+        #Then For this user model, the exit status should be 0

data/features/model/g.feature

@@ -0,0 +1,64 @@
+Feature: Generate model related things
+
+    Scenario: Enters the command with arguments
+        When I run `rails_zen model g user name:string` interactively
+        And I type "0"
+        When I close the stdin stream
+        Then the output should contain "0 name"
+
+    Scenario: Selects simple attributes
+        When I run `rails_zen model g user name:string phone:integer` interactively
+        And I type "0"
+        And I type "n"
+        When I close the stdin stream
+        Then the output should contain "Should :phone be present always in your record?"
+
+    Scenario: No unique attributes and integer
+        When I run `rails_zen model g user name:string phone:integer` interactively
+        And I type "0"
+        And I type "n"
+        And I type " "
+        When I close the stdin stream
+        Then the output should contain "phone is an integer do you want to check"
+
+    Scenario: No unique attributes, integer and has a relation
+        When I run `rails_zen model g user name:string` interactively
+        And I type "0"
+        And I type "n"
+        And I type "posts"
+        When I close the stdin stream
+        #Then the exit status should be 0
+        Then the output should contain "Do you have any has_many relations?"
+
+        #@focus
+        # file writing part
+    #Scenario: No unique attributes, integer and has a relation
+        #When I run `rails_zen model g user name:string phone:integer` interactively
+        #And I type "1"
+        #And I type "n"
+        #And I type "posts"
+        #Then the exit status should be 0
+
+
+    Scenario: No unique attributes and string
+        When I run `rails_zen model g user name:string phone:integer` interactively
+        And I type "1"
+        And I type "n"
+        And I type " "
+        Then the exit status should be 0
+
+    Scenario: not a unique attribute and a relation
+        When I run `rails_zen model g user name:string phone:integer location:belongs_to` interactively
+        And I type "0,1"
+        And I type "y"
+        Given I have all files
+        And I type "0"
+        Then the output should contain "0 if it is not unique"
+
+    Scenario: unique attribute is a relation
+        When I run `rails_zen model g user name:string phone:integer location:belongs_to` interactively
+        And I type "0,1"
+        And I type "y"
+        Given I have all files
+        And I type "1"
+        Then the output should contain "0 if it is not unique"

data/features/step_definitions/mock_file_steps.rb

@@ -0,0 +1,18 @@
+require 'rails_zen/write_to_files/write_to_model'
+
+Then /^For this (\w+) model, the exit status should be (\d+)$/ do |model, exit_status|
+  #File.open("app/models/#{model}.rb", 'w+') {|f| f.write("class #{model.capitalize} < ActiveRecord::Base\nend\n") }
+  assert_exit_status(exit_status.to_i)
+end
+
+Given /I have all files/ do
+  file  = String.new("class User < ActiveRecord::Base\nend\n")
+  loc = double('file')
+
+  allow(File).to receive(:open).with(any_args) { loc }
+  allow(File).to receive(:binread).with(any_args) { file }
+
+  allow_any_instance_of(RailsZen::WriteToModel).to receive(:file_name) { '/randompath/yo'}
+
+  allow(Dir).to receive(:glob).with(any_args) {["2023_create_users.rb"]}
+end

data/features/support/env.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
+require 'aruba/cucumber'
+require 'fileutils'
+require 'rspec/expectations'
+require 'cucumber/rspec/doubles'
+
+Before do
+  @aruba_timeout_seconds = 5
+end

data/lib/cli.rb

@@ -0,0 +1,10 @@
+require 'thor'
+require 'cli/model'
+
+module RailsZen
+  class Dexterity < Thor
+
+    desc "model COMMANDS", "Generator related to Rails modules"
+    subcommand "model", RailsZen::CLI::Model
+  end
+end

data/lib/cli/model.rb

@@ -0,0 +1,33 @@
+require "rails_zen/given_model_gen"
+require "rails_zen/model_action"
+
+module RailsZen
+  module  CLI
+    class Model < Thor
+      desc "g MODELNAME ATTRIBUTES", "generate model, migration, spec files and step & step validations"
+      long_desc %{
+
+      Eg: rails_zen g model user name:string email:string score:integer
+
+      The command generates the usual model, migration and model_spec files. After that,
+      things we manually add such as validation or uniqueness are interactively asked by
+      this command to write into model, migration and spec file.
+
+
+      }
+      def g(model_name, *attrs)
+        attrs = attrs.join(' ')
+        system("rails g model #{model_name} #{attrs}")
+        RailsZen::GivenModelGen.new(model_name, attrs).step_by_step
+
+        #check_has_many
+      end
+
+      desc "act MODELNAME NAME ", "create an actions and action spec for a model"
+      option :class
+      def act(model_name, action_name)
+        RailsZen::ModelAction.new(action_name, options[:class], model_name).write!
+      end
+    end
+  end
+end

data/lib/rails_zen.rb

@@ -0,0 +1,5 @@
+require "rails_zen/version"
+require "cli"
+
+module RailsZen
+end

data/lib/rails_zen/chosen_attr.rb

@@ -0,0 +1,89 @@
+require 'stringio'
+require 'highline/import'
+
+module RailsZen
+  class ChosenAttr
+    attr_accessor :name, :type, :validator, :type_based_validators, :scope_attr
+
+    def initialize(name, type)
+      @name = name
+      @type = type
+      @scope_attr = []
+    end
+    def get_user_inputs
+      get_presence_req
+      get_type_based_validations
+    end
+
+    def get_presence_req
+      say "\n\nShould :#{name} be present always in your record?\n"
+      say"--------------------------------------------------------------"
+      inp = agree("Reply with y or n")
+
+      if inp
+        @validator = "validates_presence_of"
+        #say "What should be the default value? If there is no default value enter n"
+        #val = $stdin.gets.strip
+        #if val != 'n'
+        #@default_value = val
+        #end
+        get_uniqueness_req
+      else
+        @validator = nil
+      end
+    end
+
+    def get_uniqueness_req
+      say "Should :#{name} be an unique column?\n"
+      say "-------------------------------------\n\n"
+      say "Reply with \n
+                  0 if it is not unique \n
+                  1 if it is just unique \n
+                  2 if it is unique with respect to another attr \n\n"
+
+      inp = ask("Please enter", Integer) { |q| q.in = 0..2 }
+
+      if inp == 2
+        #say "Setting presence true in your models and migrations"
+        say "\n#{name} is unique along with ?\n Reply with attr name\n "
+
+        if is_relation?
+          @scope_attr << "#{name}_id" unless name.end_with? "_id"
+        end
+
+        say("if it is a relation reply along with id: eg: user_id \n\n $->")
+        @scope_attr << ask("Enter (comma sep list)  ", lambda { |str| str.split(/,\s*/) })
+        @scope_attr = @scope_attr.flatten.map(&:to_sym)
+
+        @validator = "validates_uniqueness_scoped_to"
+      elsif  inp == 1
+        @validator = "validates_uniqueness_of"
+      end
+    end
+
+    def get_type_based_validations
+      if(type == "integer" || type == "decimal")
+        @validator_line = "#@validator_line, numericality: true"
+
+        say "#{name} is an integer do you want to check  \n
+                  1 just the numericality? \n
+                  2 check if it is only integer\n\n $->
+        "
+        input = ask("Please enter", Integer) { |q| q.in = 1..2}
+
+        map_input = {
+          1 => "validate_numericality", 2 => "validate_integer"
+          #"3" => "validate_greater_than", "4" => "validate_lesser_than"
+        }
+
+        @type_based_validators = map_input[input]
+
+      elsif(is_relation?)
+        @type_based_validators = "validate_belongs_to"
+      end
+    end
+    def is_relation?
+      type =="belongs_to" || type == "references" || (type.end_with? "_id")
+    end
+  end
+end