scaffold_pico 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 175c54b342e8d50e676e2bf54e99bdac1515960a
+  data.tar.gz: 103171fdcd24d32f815a669595c14844f226050c
+SHA512:
+  metadata.gz: caae14c0f717591e44525c06fb141c84deab161967fbdfc444b1b25ffafb8df55e882440f50ffad0de0b907f83daed2e9e3a69f9b809db74364db52c76725948
+  data.tar.gz: 75e15aeb60a6209f25251f6fc68fe99a45695df11f7422b7feff236dde84d84e47bfb71c9cb627bba2a3e3d49dce1cc289abd5c904024615158def7d7ddb186e

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2016 gudata
+
+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.rdoc

@@ -0,0 +1,39 @@
+= scaffold_pico
+
+ruby -I lib bin/scaffold_pico.rb  --css_framework=zurb --template=slim -m user -n Admin -i :roles :company -j :roles :company --fields name:string
+
+scaffold_pico.rb -m Admin::User -n admin/gosho -i :roles :company -j :roles :company --fields name:string
+
+ruby -I ~/scaffold_pico/lib ~/scaffold_pico/bin/scaffold_pico.rb  -m Admin::Assistant -n administation/pencho --fields first_name:string last_name:string
+
+
+ruby -I ~/scaffold_pico/lib ~/scaffold_pico/bin/scaffold_pico.rb  -m Company -n super_admin --fields name:string website:string active:string subscription:string contact_person:string
+
+
+ruby -I ~/scaffold_pico/lib ~/scaffold_pico/bin/scaffold_pico.rb -d --css_framework=materialize \
+  -m Vector -n manage -b AdminController  \
+  --fields name: featured:boolean aspect_ratio: portrait:boolean landscape:boolean imported:boolean trending:boolean width:integer height:integer transperant:boolean bw:boolean license:belongs_to group_id:integer tool:belongs_to user_id: category_id: category_display_order:integer group_display_order:integer svg:file ai:file png:file emf:file wmf:file  \
+  --index-fields id name imported featured \
+  --search-fields name aspect_ratio landscape portrait imported featured trending width height transperant bw license_id group_id tool_id user_id category_id
+
+
+== I18n
+
+en.yml:
+
+    activerecord:
+      notices:
+        success:
+          create: Was successfully created %{model}
+          update: Was successfully updated %{model}
+          destroy: Was successfully destroyed %{model}
+        failed:
+          create: Fail creating %{model}
+          update: Fail updating %{model}
+          destroy: Fail destroing %{model}
+
+== Copyright
+
+Copyright (c) 2016 gudata. See LICENSE.txt for
+further details.
+

data/bin/scaffold_pico.rb

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/scaffold/cli'
+
+cli = Scaffold::CLI.new
+cli.run

data/lib/scaffold/base_generator.rb

@@ -0,0 +1,22 @@
+module Scaffold
+  class BaseGenerator
+
+    def initialize params
+      @params = params
+    end
+
+    def objectify
+      OpenStruct.new(vars).instance_eval { binding }
+    end
+
+    # where is the root of the gem
+    def root
+      Scaffold.root
+    end
+
+    # the root of the templates
+    def templates
+      'lib/templates/pico/'
+    end
+  end
+end

data/lib/scaffold/cli.rb

@@ -0,0 +1,110 @@
+require 'scaffold_pico'
+require 'choice'
+
+module Scaffold
+  class CLI
+
+    def initialize
+      Choice.options do
+        header 'Synopsys: scaffold_pico.rb  -m user -n Admin -i :roles :company -j :roles :company --fields name:string'
+        separator ''
+        header 'Specific options:'
+
+        option :debug do
+          short '-d'
+          long '--debug'
+          desc 'print some debug info'
+        end
+
+        option :namespace do
+          short '-n'
+          long '--namespace=namespace1/namespace2'
+          validate  /\A(\w+(?:\/\w+)*)\z/
+          desc 'Optional namespace for the controllers. Example: -n admin/secret_area'
+        end
+
+        option :base_controller do
+          short '-b'
+          long '--base_controller=AdminController'
+          validate  /((::)?([A-Z])+[a-z]*)*\z/
+          desc 'Optional base controller. Example: -b Admin::BaseController'
+        end
+
+        option :model do
+          short '-m'
+          long '--model=model'
+          desc 'The model. It could be with modules. Example: ModuleA::ModuleB::SomeClassName'
+          validate  /\A(?:::)?([A-Z]\w*(?:::[A-Z]\w*)*)\z/
+        end
+
+        option :includes do
+          long '--includes=*INCLUDES'
+          desc 'add .includes(*includes) into the collection request, we have join also'
+          default []
+        end
+
+        option :joins do
+          long '--joins=*JOINS'
+          desc 'add .joins(*joins) into the collection request, we have includes also'
+          default []
+        end
+
+        option :fields do
+          long '-f'
+          long '--fields *FIELDS'
+          desc 'title:string body:text published:boolean amount:decimal tracking_id:integer:uniq '
+        end
+
+        option :index_fields do
+          long '-i'
+          long '--index-fields *FIELDS'
+          desc 'The fields you wish to see on the index page. Example: --index-fields title body published amount tracking_id'
+        end
+
+        option :search_fields do
+          long '-s'
+          long '--search-fields *FIELDS'
+          desc 'Fields on which the search will be done. Example: --search-fields title body published amount tracking_id'
+        end
+
+
+        separator ''
+        separator 'Defaults: '
+
+        option :template do
+          long '-t'
+          long '--template template'
+          default 'slim'
+          desc 'slim'
+        end
+
+        option :css_framework do
+          long '-c'
+          long '--css_framework css_framework'
+          default 'zurb'
+          desc 'zurb'
+        end
+
+        separator ''
+        separator 'Common options: '
+
+        option :help do
+          long '--help'
+          desc 'Show this message'
+        end
+
+      end
+
+
+    end
+
+    def run
+      if Choice[:model]
+        scaffold = Scaffold::Main.new(Choice.choices)
+        scaffold.run
+      else
+        puts "try #{$0} --help"
+      end
+    end
+  end
+end

data/lib/scaffold/controller_generator.rb

@@ -0,0 +1,24 @@
+module Scaffold
+  class ControllerGenerator < Scaffold::BaseGenerator
+
+    def generate
+      controller_file_path = create_path(@params.controller_file_name)
+
+      puts "Creating #{controller_file_path}"
+
+      filename = File.join(root, templates, 'controller.rb.erb')
+      content = File.read(filename)
+      # http://www.stuartellis.eu/articles/erb/
+      content = ::ERB.new(content, nil, '-').result(@params.instance_eval{ binding })
+      # puts content
+      IO.write(controller_file_path, content)
+    end
+
+    def create_path file_name
+      controller_path = File.join(Dir.pwd, 'app', 'controllers', @params.namespaces_array)
+      controller_file_path = File.join(controller_path, file_name)
+      FileUtils.mkpath(controller_path)
+      controller_file_path
+    end
+  end
+end

data/lib/scaffold/main.rb

@@ -0,0 +1,15 @@
+module Scaffold
+  class Main
+    def initialize choice
+      @params = Params.new(choice)
+    end
+
+    def run
+      Scaffold::ControllerGenerator.new(@params).generate
+      Scaffold::ModelsGenerator.new(@params).generate
+      Scaffold::ViewsGenerator.new(@params).generate
+      Scaffold::RoutesGenerator.new(@params).generate
+    end
+
+  end
+end

data/lib/scaffold/models_generator.rb

@@ -0,0 +1,30 @@
+module Scaffold
+  class ModelsGenerator < Scaffold::BaseGenerator
+    def generate
+      searches_path = create_searches_path
+      puts "Don't forget to add 'app/services' in your autoload_paths (application.rb)"
+      create_search_object searches_path
+    end
+
+    def create_search_object searches_path
+      source_file_name = "search.rb.erb"
+      target_file_name = "#{@params.resource_name.pluralize}_search.rb"
+
+      source_file_path = File.join(root, templates, source_file_name)
+      content = File.read(source_file_path)
+
+      content = ::ERB.new(content, nil, '-').result(@params.instance_eval{ binding })
+
+      target_file_path = File.join(searches_path, target_file_name)
+      IO.write(target_file_path, content)
+    end
+
+    def create_searches_path
+      searches_path = File.join(Dir.pwd, 'app', 'services', 'search', @params.namespaces_array)
+      FileUtils.mkpath(searches_path)
+      searches_path
+    end
+
+
+  end
+end

data/lib/scaffold/params.rb

@@ -0,0 +1,106 @@
+module Scaffold
+  class Params
+    attr_reader :resource_name, :namespaces_array, :controller_file_name, :template, :css_framework, :views_folder_name, :route_resource_name
+
+    def expand_default_types hash
+      hash.each_pair do |key, value|
+        hash[key] = 'string' if value.blank?
+      end
+    end
+
+    def initialize choice
+      (@modules, @model_name) = parse_model(choice[:model]) # what came from the params (it contain namespaces)
+
+      @fields = expand_default_types(hasherize_fields(choice[:fields]))
+      @index_fields = choice[:index_fields].blank? ? @fields.keys : choice[:index_fields]
+      @search_fields = choice[:search_fields].blank? ? @fields.keys : choice[:search_fields]
+
+      @joins = choice[:joins]
+      @includes = choice[:includes]
+      @template = choice[:template]
+      @css_framework = choice[:css_framework]
+
+      @resource_class_name = @model_name.singularize # CompanyOwnership
+      # Admin::User or only User
+      if @modules.empty?
+        @modulized_resource_class_name = @resource_class_name
+      else
+        @modulized_resource_class_name =  "#{@modules.join('::')}::#{@resource_class_name}"
+      end
+
+      # routes
+      @route_resource_name = @model_name.tableize # resoures :users
+      @namespace = choice[:namespace] # for the controllers
+      @base_controller = choice[:base_controller] || 'ApplicationController'
+      @namespaces_array = parse_namespaces_array(@namespace)  # [:admin, ...?... ]
+
+      # controller
+      @controller_namespaces = @namespace.camelize
+
+      if @namespaces_array.blank?
+        @controller_class_name = "#{@model_name.pluralize}Controller"
+        @search_modulized_resource_class_name = "Search::#{@resource_class_name}Search"
+      else
+        @controller_class_name = "#{@controller_namespaces}::#{@model_name.pluralize}Controller"
+        @search_modulized_resource_class_name =  "Search::#{@controller_namespaces}::#{@resource_class_name.pluralize}Search"
+      end
+      @controller_file_name = "#{@resource_class_name.tableize}_controller.rb"
+
+      @resource_name = @model_name.tableize.singularize # user for use in @user or filenames
+      @collection_name = @model_name.tableize # users for use in @users
+
+      # view
+      @views_folder_name = @model_name.tableize # users
+
+      @path_segments = @namespaces_array.map{|segment| segment.to_sym }
+      @new_resource_path = "[:new, #{@path_segments.map{|item| ":#{item}"}.join(", ")}, :#{@resource_name}]"
+
+      @resource_path = "[#{@path_segments.map{|item| ":#{item}"}.join(", ")}, #{@resource_name}]"
+      @edit_resource_path = "[:edit, #{@path_segments.map{|item| ":#{item}"}.join(", ")}, #{@resource_name}]"
+
+      @instance_resource_path = "[#{@path_segments.map{|item| ":#{item}"}.join(", ")}, @#{@resource_name}]"
+      @instance_edit_resource_path = "[:edit, #{@path_segments.map{|item| ":#{item}"}.join(", ")}, @#{@resource_name}]"
+
+      @collection_path = @path_segments.dup << @collection_name.to_sym
+
+      debug_info if choice[:debug]
+    end
+
+    def debug_info
+      puts "\n"
+      puts "Debug:"
+      puts "resource_class_name: #{@resource_class_name}, resource_name: #{@resource_name}, collection_name: #{@collection_name}"
+      puts "modulized_resource_class_name: #{@modulized_resource_class_name}"
+
+      puts "\ncontroller:"
+      puts "class: #{@controller_class_name}"
+
+      puts "\nroutes:"
+      puts "route_resource_name: #{@route_resource_name}"
+      puts "namespaces_array: #{@namespaces_array} (for urls helpers)"
+      puts "resource_path: #{@resource_path}, resource_name: #{@collection_path}"
+      puts "collection_path: #{@collection_path}"
+      puts "\n\n"
+    end
+
+    def parse_model model
+      chunks = model.split('::').select{|chunk| !chunk.empty?}
+      class_name = chunks.pop
+      [chunks, class_name]
+    end
+
+    def parse_namespaces_array namespace
+      namespace.split('/').collect{|name| name.underscore}
+    end
+
+    def hasherize_fields fields_array
+      fields = {}
+      fields_array.each do |field_string|
+        (key, value) = field_string.split(':')
+        fields[key] = value
+      end
+      fields
+    end
+
+  end
+end

data/lib/scaffold/routes_generator.rb

@@ -0,0 +1,29 @@
+module Scaffold
+  class RoutesGenerator < Scaffold::BaseGenerator
+
+    def generate
+      puts "Insert something like this in routes.rb"
+      namespaces_count = @params.namespaces_array.count
+      route_string = "#{spaces(namespaces_count+2)}resources :#{@params.route_resource_name}"
+
+      @params.namespaces_array.reverse.each_with_index do |namespace, index|
+        route_string = namespace_block(namespace, namespaces_count - index, route_string)
+      end
+      puts route_string
+    end
+
+    def spaces(count)
+      " "*2*(count)
+    end
+
+    def namespace_block namespace, index, route_string
+      ident = spaces(index+1)
+
+      begin_namespace_line = "#{ident}namespace :#{namespace} do"
+      namespace = "#{ident*2}#{namespace}"
+      end_namespace_line = "#{ident}end"
+      "#{begin_namespace_line}\n#{route_string}\n#{end_namespace_line}"
+    end
+
+  end
+end

data/lib/scaffold/template_engines/slim.rb

@@ -0,0 +1,15 @@
+module Scaffold
+  module TemplateEngines
+    class Slim
+
+      def extension
+        'slim'
+      end
+
+      def source_folder_name
+        'slim'
+      end
+
+    end
+  end
+end

data/lib/scaffold/views_generator.rb

@@ -0,0 +1,49 @@
+module Scaffold
+  class ViewsGenerator < Scaffold::BaseGenerator
+    def generate
+      views_path = create_views_path
+      templating_engine = choose_templating_engine
+      print "Creating view:"
+      %w(index new edit show _form).each do |view_name|
+        print view_name, ' '
+        create views_path, view_name, templating_engine, css_framework
+      end
+      print "\n"
+    end
+
+    def create views_path, view_name, templating_engine, css_framework
+      source_file_name = "#{view_name}.html.#{templating_engine.extension}.erb"
+      target_file_name = "#{view_name}.html.#{templating_engine.extension}"
+      source_file_path = File.join(root, templates, 'views',
+        css_framework,
+        templating_engine.source_folder_name,
+        source_file_name)
+      content = File.read(source_file_path)
+
+      # http://www.stuartellis.eu/articles/erb/
+      content = ::ERB.new(content, nil, '-').result(@params.instance_eval{ binding })#.gsub(/\s+\n$/, "")
+
+      target_file_path = File.join(create_views_path, target_file_name)
+      IO.write(target_file_path, content)
+    end
+
+    def create_views_path
+      views_path = File.join(Dir.pwd, 'app', 'views', @params.namespaces_array, @params.views_folder_name)
+      FileUtils.mkpath(views_path)
+      views_path
+    end
+
+
+    def choose_templating_engine
+      case @params.template
+      when 'slim'
+        ::Scaffold::TemplateEngines::Slim.new
+      end
+    end
+
+    def css_framework
+      @params.css_framework
+    end
+
+  end
+end

data/lib/scaffold_pico.rb

@@ -0,0 +1,19 @@
+require 'active_support/inflector'
+require 'active_support/core_ext/object/blank'
+require 'ostruct'
+require 'scaffold/main'
+require 'scaffold/params'
+require 'scaffold/base_generator'
+require 'scaffold/controller_generator'
+require 'scaffold/models_generator'
+require 'scaffold/views_generator'
+require 'scaffold/routes_generator'
+require 'scaffold/template_engines/slim'
+require 'erb'
+require 'fileutils'
+
+module Scaffold
+  def self.root
+    File.dirname __dir__
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: scaffold_pico
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- gudata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: choice
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: require_all
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+description: Scaffolding
+email: i.bardarov@gmail.com
+executables:
+- scaffold_pico.rb
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- LICENSE.txt
+- README.rdoc
+- bin/scaffold_pico.rb
+- lib/scaffold/base_generator.rb
+- lib/scaffold/cli.rb
+- lib/scaffold/controller_generator.rb
+- lib/scaffold/main.rb
+- lib/scaffold/models_generator.rb
+- lib/scaffold/params.rb
+- lib/scaffold/routes_generator.rb
+- lib/scaffold/template_engines/slim.rb
+- lib/scaffold/views_generator.rb
+- lib/scaffold_pico.rb
+homepage: http://github.com/gudata/scaffold_pico
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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.4.6
+signing_key: 
+specification_version: 4
+summary: Scaffold should be simple
+test_files: []
+has_rdoc: