scaffoldish 0.0.0 → 0.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2ba3a6526acca78f0a10c197d50b9020cfb0f6e3
-  data.tar.gz: 3af7bec1a1e7b427a062583d2fe3ba689ed4a706
+  metadata.gz: b89f6f556df00309eef7c0722c8e819a907a0654
+  data.tar.gz: 3d4e1e96248cf1f4ff5da83d38f21311e3476f54
 SHA512:
-  metadata.gz: 943dedc6201fdcce14afff7a827f95b6a2ed31bc862d56b36ae9ddceeda500f74b555da5556d46f036de1d1d3422083c7192a794376e87a483c303c8ed193bbb
-  data.tar.gz: 7ca344511d64848f5d91fd1580e390251d21c51c51b42c0cbca40e408b6dc0cb62fd02f29eaa313be1ec4f3e8d6ef04676cd47b9dec1fa28c0268d7b9d362745
+  metadata.gz: 9561b156509657eb847bf32734086e2c1bde5c79143edcf165978041633215ef7a13bf1f8a18d67944c5584e1ea3368c77abc8461ddc4da3d0dcd814b2343837
+  data.tar.gz: 6b241c6aefdf2dc6c210f4ca3683cfd7322e012d2000792d8cd0754aa75ce43927bb69df559de2c2fead730280778d9549a3c08a5ee7f38206b692c015f19175

data/README.md

@@ -1,7 +1,90 @@
-# Scaffolder-ish
+# Scaffoldish
 
-*Universal scaffolder super powa for everyone!*
+*Universal scaffolding super powa for everyone!*
 
-**Under high development... Be careful!**
+[![Gem Version](https://badge.fury.io/rb/scaffoldish.svg)](http://badge.fury.io/rb/scaffoldish)
+
+
+[![Build Status](https://travis-ci.org/debona/Scaffoldish.svg)](https://travis-ci.org/debona/Scaffoldish)
+[![Coverage Status](https://coveralls.io/repos/debona/Scaffoldish/badge.png)](https://coveralls.io/r/debona/Scaffoldish)
+[![Code Quality](https://codeclimate.com/github/debona/Scaffoldish.png)](https://codeclimate.com/github/debona/Scaffoldish)
 
 Brings Rails-ish scaffolding super powa for every developpers, no matter they don't code with blessed RoR.
+
+Current development status: Scaffoldish is still a **prototype**
+
+That means your opinion is welcome and contributions will be appreciated.
+
+## Install it
+
+To install it, run `gem install scaffoldish` in your terminal to get the latest _stable_ version.
+
+## Prepare your projects
+
+Create a `./Scaffoldable` configuration file at your project root like that:
+
+```ruby
+require 'ostruct'
+
+project_root = File.dirname(__FILE__) # Ensure your project root is where your Scaffoldable live
+templates_root = File.join(project_root, 'templates') # Specify the dir in which you drop your templates
+
+scaffold :Model do |name, attribute| # Create a scaffold that you will call to generate files
+
+  # Prepare your data before to generate files
+  data = OpenStruct.new()
+  data.name = name = name.capitalize
+  data.attribute = attribute = attribute.downcase
+
+  # This will generate a file Model.java by executing the template Model.java.erb with data
+  generate('Model.java.erb', "#{name}.java", data)
+
+  # This will print console output asking to edit Controller.java by executing the template Controller.java.erb with data
+  chunk('Controller.java.erb', 'Controller.java', data)
+end
+```
+
+Create the two templates in `./templates/`:
+
+`Model.java.erb`:
+```java
+public class <%= name %> {
+	int <%= attribute %> = 0;
+}
+```
+
+`Controller.java.erb`:
+```java
+	Add the following attribute:
+	<%= name %> <%= name.downcase %> = new <%= name %>();
+```
+
+## Let's scaffold!
+
+Open a terminal in your project and run: `cd your/project`
+
+Then generate a new "Model" by running:
+
+```shell
+$ scaffoldish Model herp derp
+```
+
+It print that in your console, indicating what you should add to your `Controller.java`.
+
+	Run Model:
+	Edit Controller.java:
+		Add the following attribute:
+		Herp herp = new Herp();
+
+It also generate the model `Herp`
+
+`Herp.java`:
+```java
+public class Herp {
+	int derp = 0;
+}
+```
+
+## Licensing
+
+See LICENSE.md

data/bin/scaffoldish

@@ -2,6 +2,16 @@
 
 require 'scaffoldish'
 
-# TODO include the logger method?
+logger = Logger.new(STDERR)
+logger.level = Logger::WARN
 
-Scaffoldish::Application.instance.run(*ARGV)
+Kernel.send(:define_method, :logger) do
+  logger
+end
+
+begin
+  Scaffoldish::Application.instance.run(*ARGV)
+rescue Exception => e
+  logger.error 'Scaffoldish crashed'
+  logger.error e
+end

data/lib/scaffoldish/application.rb

@@ -1,5 +1,9 @@
 require 'singleton'
 require 'logger'
+require 'optparse'
+
+require 'scaffoldish/scaffold'
+require 'scaffoldish/dsl/conf'
 
 module Scaffoldish
 
@@ -7,17 +11,57 @@ module Scaffoldish
 
     include Singleton
 
-    attr_reader :logger
+    attr_reader :workspace
+    attr_reader :scaffolds, :project_root, :templates_root
 
     def initialize
-      @logger = Logger.new(STDERR) # TODO: make a module with that
-      @logger.level = Logger::WARN
+      @workspace = Object.new
+      @workspace.extend(DSL::Conf)
+
+      @scaffolds = {}
+      @project_root = Dir.pwd
+      @templates_root = File.join(@project_root, 'templates')
     end
 
-    def run(command_file, *parameters)
-      puts "Hello world, I'm scaffoldish!"
-    rescue Exception => e
-      logger.error e
+    def load_config
+      config_filename = 'Scaffoldable'
+      config_path = Dir.pwd
+
+      while config_path != '/' && !File.exist?(File.join(config_path, config_filename))
+        config_path = File.expand_path("..", config_path)
+      end
+
+      config = File.read(File.join(config_path, config_filename))
+      @project_root = config_path
+
+      workspace.scaffolds = @scaffolds
+      workspace.project_root = @project_root
+      workspace.templates_root = @templates_root
+
+      workspace.instance_eval(config)
+
+      @scaffolds = workspace.scaffolds
+      @project_root = workspace.project_root
+      @templates_root = workspace.templates_root
+    end
+
+    def run(*args)
+
+      load_config
+
+      scaffold_name = args.shift
+
+      # Parameters checking
+      raise OptionParser::MissingArgument.new("$1 => scaffold_name") if scaffold_name.nil?
+      unless scaffolds.has_key?(scaffold_name.to_sym)
+        raise OptionParser::InvalidArgument.new("$1 => scaffold_name should be one of the followings: #{scaffolds.keys}")
+      end
+
+      scaffold = scaffolds[scaffold_name.to_sym]
+
+      puts "Run #{scaffold_name}:"
+
+      scaffold.run(*args)
     end
 
   end

data/lib/scaffoldish/dsl/conf.rb

@@ -0,0 +1,20 @@
+
+require 'scaffoldish/scaffold'
+
+module Scaffoldish
+
+  module DSL
+
+    module Conf
+
+      attr_accessor :scaffolds, :project_root, :templates_root
+
+      def scaffold(name, &block)
+        @scaffolds ||= {}
+        @scaffolds[name.to_sym] = Scaffold.new(name.to_sym, &block)
+      end
+
+    end
+
+  end
+end

data/lib/scaffoldish/dsl/template.rb

@@ -0,0 +1,50 @@
+
+require 'fileutils'
+require 'erb'
+
+require 'scaffoldish/application'
+
+module Scaffoldish
+
+  module DSL
+
+    module Template
+
+      def generate(template_path, output_path, data)
+        template = File.read(File.join(Application.instance.templates_root, template_path))
+        renderer = ERB.new(template)
+
+        result = renderer.result(data.instance_eval { binding })
+
+        absolute_output_path = File.join(Application.instance.project_root, output_path)
+
+        if File.exist?(absolute_output_path)
+          puts("Can't generate #{absolute_output_path}, it already exists. Skip it")
+          return
+        end
+
+        dir = File.dirname(absolute_output_path)
+        FileUtils.mkpath(dir)
+
+        File.open(absolute_output_path, 'w') do |file|
+          file.write(result)
+        end
+      end
+
+      def chunk(template_path, output_path, data)
+        template = File.read(File.join(Application.instance.templates_root, template_path))
+        renderer = ERB.new(template)
+
+        result = renderer.result(data.instance_eval { binding })
+
+        puts "Edit #{output_path}:"
+        puts result
+        puts ""
+      end
+
+    end
+
+  end
+
+end
+

data/lib/scaffoldish/scaffold.rb

@@ -0,0 +1,23 @@
+
+require 'scaffoldish/dsl/template'
+
+module Scaffoldish
+
+  class Scaffold
+
+    include DSL::Template
+
+    attr_reader :name, :block
+
+    def initialize(name, &block)
+      @name  = name
+      @block = block || Proc.new {}
+    end
+
+    def run(*args)
+      instance_exec(*args, &block)
+    end
+
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: scaffoldish
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Thomas DE BONA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-21 00:00:00.000000000 Z
+date: 2014-12-09 00:00:00.000000000 Z
 dependencies: []
 description: Brings Rails-ish scaffolding super powa for every developpers, no matter
   they don't code with blessed RoR.
@@ -23,7 +23,10 @@ files:
 - bin/scaffoldish
 - lib/scaffoldish.rb
 - lib/scaffoldish/application.rb
-homepage: http://rubygems.org/gems/scaffold-ish
+- lib/scaffoldish/dsl/conf.rb
+- lib/scaffoldish/dsl/template.rb
+- lib/scaffoldish/scaffold.rb
+homepage: http://github.com/debona/Scaffoldish
 licenses:
 - MIT
 metadata: {}
@@ -46,5 +49,5 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Universal scaffolder super powa for everyone!
+summary: Universal scaffolding super powa for everyone!
 test_files: []