scaffold_pico 0.3.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db999314a138c83372b024bb12aa24fa0d8ffd2c
-  data.tar.gz: 06b51f2ecb4f590dec20f30a27ba122f1b6ec181
+  metadata.gz: 51f562ce19e922d879648cf3db894dea6a96a9c6
+  data.tar.gz: 1321074674bc39be2a893ff9bbcd4dda70259d5e
 SHA512:
-  metadata.gz: 858219492d605912c41b702d98ddfc80e320afd89e94eb1a63246e4f1f1ce68f22ce767945710488f59de04749d02a6b10dfb3c4c80a25eb436148f69e4caa7b
-  data.tar.gz: 3bc2d99ea61606324f136d9b8ef1852ae94095612eafe9534910573b38e9b69ba61c41143f7b061bf66080656368b416a0b6fa2d8c69f872d97fe77b0bc3116b
+  metadata.gz: 8bfcbd09575b717f2720f3ffdf1f1c45e7c40f904ff8607d333f4f7859a2a7bc5cc862b5a9ea40b002f4ea8ed694829abbf40e1d659f989a1ee0c72ffc37ed09
+  data.tar.gz: 220ba11acff7b3cd7a610eef5edaaf1add7e2b94530ee2e5fddaef3dc8b9403261db18c2c96b5381e39c4cd82771f3079df0f10eba7e44fc58caa21e6c55e3f8

data/README.md

@@ -15,9 +15,14 @@ No need to learn DSLs or support 3rd party gems.
 * You can specify includes/joins for the #index action
 * Includes search
 
+![alt tag](https://raw.githubusercontent.com/gudata/scaffold_pico/master/doc/screenshot_index.jpg)
+
+
 # SYNOPSIS
 
-    scaffold_pico.rb -m Admin::Vector -n administration -b AdminController \
+    scaffold_pico.rb \
+      -m Admin::Vector -n administration -b AdminController \
+      --nested_in_resources Assets::VectorFrame \
       --fields name: description:text featured:boolean license:belongs_to group_id:integer svg:file \
       --index-fields id name imported featured \
       --search-fields name aspect_ratio license created_at \
@@ -25,54 +30,27 @@ No need to learn DSLs or support 3rd party gems.
       --services_folder=services \
       --debug --css_framework=materialize
 
+
 # Install
+The gem assume you have already in your Gemfile
+
+    gem 'kaminari'
+    gem 'slim-rails'
+    gem 'simple_form'
+
+    # And one of those
+    #
+    # gem 'materialize-sass'
+    # gem 'foundation-rails'
 
 There is no need to have it in your gem file.
 
     gem install scaffold_pico
 
-Set some default I18n options
-
-  en.yml:
-
-    scaffold:
-      confirm: 'Are you sure?'
-      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}
-      new:
-        title: "New %{model}"
-      show:
-        title: "%{model}"
-      edit:
-        title: "Edit %{model}"
-      index:
-        title: "%{model}"
-        edit: Edit
-        show: Show
-        destroy: Delete
-        actions: Action
-        search:
-          header: Search
-          button: Search
-          reset: New
-
-      actions:
-        index: List %{model}
-        actions: 'Actions'
-        new: New %{model}
-        edit: Edit %{model}
-
 # Overriding
-If you want to change something you can put it in
-
+If you want to change something you can override/change
 
+    RAILS_ROOT/config/locales/en.scaffold_pico.yml
     RAILS_ROOT/lib/templates/pico
                                 /controller.rb
                                 /search.rb
@@ -104,17 +82,15 @@ Clone the repo in ~/scaffold_pico or whatever, then in some rails project run th
       --fields name:string
 
 # Known Issues
-Help please: For some of the generated models/views there are extra blank links. It would be great if someone knows how to parse the erb and skip the new lines
+If you can't start scaffold_pico you might need to update your bundler
 
-It would be great if someone wants to make a pull request for erb output
+    gem update bundler
 
-Overwrites the existing files without warnings!
+Help please: For some of the generated models/views there are extra blank links. It would be great if someone knows how to parse the erb and skip the new lines
 
 You can't generate scaffolds for a mounted named engines. I don't know if we need this feature.
 
-The Param class has become very messy because of all those variables, so it should be split in small helpers.
-
 
 ## Copyright
 
-Copyright (c) 2016 gudata. See LICENSE.txt for further details.
+Copyright (c) 2017 gudata. See LICENSE.txt for further details.

data/lib/scaffold/cli.rb

@@ -16,16 +16,28 @@ module Scaffold
           desc 'print some debug info'
         end
 
+        option :force do
+          long '--force'
+          desc 'Overwrite without asking questions'
+        end
+
         option :fabrication do
           long '--fabrication'
           desc 'Generate fabrication fabricator https://github.com/paulelliott/fabrication'
         end
 
-        option :namespace do
+        option :controller_namespaces do
           short '-n'
-          long '--namespace=namespace1/namespace2'
+          long '--controller_namespaces=namespace1/namespace2'
           validate  /\A(\w+(?:\/\w+)*)\z/
-          desc 'Optional namespace for the controllers. Example: -n admin/secret_area'
+          desc 'Optional namespaces for the controllers. Example: -n admin/secret_area. '
+        end
+
+        option :nested_in_resources do
+          short '-nr'
+          long '--nested_in_resources=Reports::Client/Building'
+          validate  /\A(?:::)?(?:(?:[A-Z]\w*(?:::[A-Z]\w*)*)\/?)*\z/
+          desc 'Optional nest resource in other resources. Example: -nr Reports::Client/Building -m Room'
         end
 
         option :base_controller do
@@ -57,7 +69,7 @@ module Scaffold
         option :fields do
           long '-f'
           long '--fields *FIELDS'
-          desc 'title:string body:text published:boolean amount:decimal attachment:file tracking_id:integer:uniq '
+          desc 'title:string library:belongs_to body:text published:boolean amount:decimal attachment:file tracking_id:integer:uniq '
         end
 
         option :index_fields do

data/lib/scaffold/erb_context.rb

@@ -0,0 +1,11 @@
+class ErbContext
+  def initialize(hash)
+    hash.each_pair do |key, value|
+      instance_variable_set('@' + key.to_s, value)
+    end
+  end
+
+  def get_binding
+    binding
+  end
+end

data/lib/scaffold/generators/base_generator.rb

@@ -0,0 +1,74 @@
+require 'readline'
+
+module Scaffold
+  module Generators
+    class BaseGenerator
+      @@aways_ovewrite = false
+
+      def initialize rails
+        @rails = rails
+      end
+
+      def objectify
+        OpenStruct.new(vars).instance_eval { binding }
+      end
+
+      # where is the root of the gem
+      def root
+        Scaffold.root
+      end
+
+      def project_root
+        Dir.pwd
+      end
+
+      # Check to see if it is overridden and use it
+      def find_root *segments
+        original = File.join(root, segments)
+        overridden = File.join(project_root, segments)
+        File.exists?(overridden) ? overridden : original
+      end
+
+      # the root of the templates
+      def templates
+        'lib/templates/pico/'
+      end
+
+      def ask(prompt="", newline=false)
+        prompt += "\n" if newline
+        Readline.readline(prompt, true).squeeze(" ").strip
+      end
+
+      def write_with_confirmation(target_file_path, content)
+        unless File.exists?(target_file_path)
+          IO.write(target_file_path, content)
+          return
+        end
+
+        @@aways_ovewrite = 'a' if @rails.choice[:force].present?
+
+        answer = if @@aways_ovewrite
+          if @rails.choice[:force].blank?
+            puts "#{target_file_path} exists, overwrite? [yaN] y"
+          end
+          'y'
+        else
+           ask("#{target_file_path} exists, overwrite? [yaN]").downcase
+        end
+
+        @@aways_ovewrite = true if answer == 'a'
+
+        IO.write(target_file_path, content) if answer == 'y'
+      end
+
+      def parse_template(content, context_hash)
+        # http://www.stuartellis.eu/articles/erb/
+        # content = ::ERB.new(content, nil, '-').result(@params.instance_eval{ binding })#.gsub(/\s+\n$/, "")
+
+        # content = ::ERB.new(content, 0, '>').result(ErbContext.new(context_hash).get_binding)
+        content = ::ERB.new(content, 0, '-').result(ErbContext.new(context_hash).get_binding)
+      end
+
+    end
+  end
+end

data/lib/scaffold/generators/controller_generator.rb

@@ -0,0 +1,27 @@
+module Scaffold
+  module Generators
+    class ControllerGenerator < Scaffold::Generators::BaseGenerator
+
+      def generate
+        controller_file_path = create_path(@rails.controller.file_name)
+
+        # puts "Creating #{controller_file_path}"
+
+        filepath = find_root(templates, 'controller.rb.erb')
+        content = File.read(filepath)
+
+        content = parse_template(content, {rails: @rails})
+
+        # puts content
+        write_with_confirmation(controller_file_path, content)
+      end
+
+      def create_path file_name
+        controller_path = File.join(Dir.pwd, 'app', 'controllers', @rails.controller.namespaces_as_path)
+        controller_file_path = File.join(controller_path, file_name)
+        FileUtils.mkpath(controller_path)
+        controller_file_path
+      end
+    end
+  end
+end

data/lib/scaffold/generators/fabricator_generator.rb

@@ -0,0 +1,26 @@
+module Scaffold
+  module Generators
+    class FabricatorGenerator < Scaffold::Generators::BaseGenerator
+      def generate
+        fabricators_path = create_fabricators_path
+        source_file_name = "fabrication.rb.erb"
+        target_file_name = "#{@rails.resource.name}_fabricator.rb"
+        source_file_path = find_root(templates, 'fabricators', source_file_name)
+        content = File.read(source_file_path)
+
+        content = parse_template(content, {rails: @rails})
+
+        target_file_path = File.join(fabricators_path, target_file_name)
+
+        write_with_confirmation(target_file_path, content)
+      end
+
+      def create_fabricators_path
+        fabricators_path = File.join(Dir.pwd, 'spec', 'fabricators')
+        FileUtils.mkpath(fabricators_path)
+        fabricators_path
+      end
+
+    end
+  end
+end

data/lib/scaffold/generators/locales_generator.rb

@@ -0,0 +1,42 @@
+module Scaffold
+  module Generators
+    class LocalesGenerator < Scaffold::Generators::BaseGenerator
+      def generate
+        return if existing_locale?
+        generate_locale('en')
+        generate_locale('bg')
+      end
+
+      def existing_locale?
+        Dir.glob(File.join(locales_path, '**')).each do |name|
+          return true if File.basename(name) =~ /scaffold_pico.yml/
+        end
+        return false
+      end
+
+      def generate_locale(locale)
+        locales_path = create_locales_path
+        source_file_name = "#{locale}.scaffold_pico.yml.erb"
+        target_file_name = "#{locale}.scaffold_pico.yml"
+        source_file_path = find_root(templates, 'locales', source_file_name)
+        content = File.read(source_file_path)
+
+        content = parse_template(content, {rails: @rails})
+
+        target_file_path = File.join(locales_path, target_file_name)
+
+        write_with_confirmation(target_file_path, content)
+      end
+
+      def locales_path
+        locales_path = File.join(Dir.pwd, 'config', 'locales')
+      end
+
+      def create_locales_path
+        FileUtils.mkpath(locales_path)
+        locales_path
+      end
+
+    end
+  end
+end

data/lib/scaffold/generators/models_generator.rb

@@ -0,0 +1,53 @@
+module Scaffold
+  module Generators
+    class ModelsGenerator < Scaffold::Generators::BaseGenerator
+      def generate
+        searches_path = create_searches_path
+        puts "Add '#{@rails.resource.services_folder}' folder in your autoload_paths (application.rb)"
+        create_search_object searches_path
+        create_model
+      end
+
+      def create_model
+        source_file_name = "model.rb.erb"
+        target_file_name = @rails.resource.file_name
+
+        source_file_path = find_root(templates, source_file_name)
+        content = File.read(source_file_path)
+
+        content = parse_template(content, {rails: @rails})
+
+        if @rails.resource.modules?
+          model_path = File.join(Dir.pwd, 'app', 'models')
+        else
+          model_path = File.join(Dir.pwd, 'app', 'models', @rails.resource.modules.map(&:underscore))
+          FileUtils.mkdir_p model_path
+        end
+
+        target_file_path = File.join(model_path, target_file_name)
+
+        write_with_confirmation(target_file_path, content)
+      end
+
+      def create_search_object searches_path
+        source_file_name = "search.rb.erb"
+        target_file_name = "#{@rails.resource.name.pluralize}_search.rb"
+
+        source_file_path = find_root(templates, source_file_name)
+        content = File.read(source_file_path)
+
+        content = parse_template(content, {rails: @rails})
+
+        target_file_path = File.join(searches_path, target_file_name)
+        write_with_confirmation(target_file_path, content)
+      end
+
+      def create_searches_path
+        searches_path = File.join(Dir.pwd, 'app', @rails.resource.services_folder, 'search', @rails.controller.namespaces_as_path)
+        FileUtils.mkpath(searches_path)
+        searches_path
+      end
+
+    end
+  end
+end

data/lib/scaffold/generators/routes_generator.rb

@@ -0,0 +1,48 @@
+module Scaffold
+  module Generators
+    class RoutesGenerator < Scaffold::Generators::BaseGenerator
+
+      def generate
+        puts "Insert something like this in routes.rb"
+
+        nested_resources = @rails.nested_in_resources.resources
+        nested_resources_count = nested_resources.count
+
+        namespaces_count = @rails.controller.namespaces_as_path.count
+
+        route_string = "#{spaces(nested_resources_count + namespaces_count + 2)}resources :#{@rails.route.resource_name}"
+
+        nested_resources.reverse.each_with_index do |resource, index|
+          route_string = resources_block(resource.name, namespaces_count + nested_resources_count - index, route_string)
+        end
+
+        @rails.controller.namespaces_as_path.reverse.each_with_index do |namespace, index|
+          index
+          route_string = namespace_block(namespace, namespaces_count - index, route_string)
+        end
+        puts route_string
+      end
+
+      def spaces(count)
+        " "*2*(count)
+      end
+
+      def resources_block resource_name, index, route_string
+        ident = spaces(index+1)
+
+        begin_resource_name_line = "#{ident}resources :#{resource_name.pluralize} do"
+        end_resource_name_line = "#{ident}end"
+        "#{begin_resource_name_line}\n#{route_string}\n#{end_resource_name_line}"
+      end
+
+      def namespace_block namespace, index, route_string
+        ident = spaces(index+1)
+
+        begin_namespace_line = "#{ident}namespace :#{namespace} do"
+        end_namespace_line = "#{ident}end"
+        "#{begin_namespace_line}\n#{route_string}\n#{end_namespace_line}"
+      end
+
+    end
+  end
+end