kadim 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e28919fd08424ba733eb143d20dfe0e26736893f9ec3d9d284502bc5cbd9c9a
-  data.tar.gz: 02bb8d94e7cd1b4e79917a090eecc53623fa0c60fed2d63d7d5abdf2e58a6ca5
+  metadata.gz: 371d7c712488e0bd60536420e63236cfb37e7c97b90450e39a58d8f83839d327
+  data.tar.gz: 69b09fd55aee468869ef81e198b7457feaaff206afbafef3dc9fabc0f74f8674
 SHA512:
-  metadata.gz: 8ff6119ceaa400e9c72c2faa391d7c39cd750baa2a3e6baef9ee5802682b4504bb1e581a20c12033a0a2aed33fff98be7ceb98c9b030cd6fdd981942a791d188
-  data.tar.gz: 5d145ad9cb9e3655ae248c9c844455f030c207d9897a49305cdefa7125f70a5ce3cb90fe17600161b8230fe457fd6954dd291fc0822f80503dd9a5cdfb1e78c6
+  metadata.gz: 90e882c703bafbed037d2b6f664b1e49b19ec4f132be0f98226485a56e781e40ea04318a20ab65138adc9900bd581c061af139a3cc067771cd0c6ad6dbaea6c5
+  data.tar.gz: 2b9a1636ea547f41eb6fd76063f9dbc737790dbcc2e5b598a57270796f614b3797706fd0c1caad95e38aa8d22bb71ba151c4afdb6ba653673fb234eca599db44

data/README.md

@@ -25,10 +25,26 @@ ActiveRecord methods added by gems are ignored.
 Files are generated in `tmp/kadim` and loaded into memory, including views. This also has the advantage of allowing the
 gem to work in environments with ephemeral file systems.
 
-If you want to customize `Kadim::ApplicationController`, the basic controller for all generated controllers, you can
-copy the file [app/controllers/kadim/application_controller.rb](https://github.com/fnix/kadim/blob/master/app/controllers/kadim/application_controller.rb)
-to your application. You can do the same for [app/views/layouts/kadim/application.html.erb](https://github.com/fnix/kadim/blob/master/app/views/layouts/kadim/application.html.erb).
-If you want to customize the generated controller/views just copy them from `tmp/kadim` to your application.
+## Customization
+
+You can manually copy kadim files and put them in the same path within your application. You will probably want to do
+this with the main kadim controller, to add safety rules, etc.
+
+You also provide two generators to make this task easier.
+
+```bash
+rails g kadim: host
+rails g kadim: host: scaffold_controller ModelName
+```
+
+The first one copies the basic kadim infrastructure to your application, ie the
+[main controller](app/controllers/kadim/application_controller.rb), the
+[main view](app/views/kadim/application/index.html.erb) and its [layout](app/views/layouts/kadim/application.html.erb),
+a [helper](app/helpers/kadim/application_helper.rb) and [assets](app/assets/).
+
+The second copies the files that kadim dynamically generates into your application, allowing you to have full control
+over controller and views implementation. This generator is a thin layer over the Rails scaffold_controller, but it only
+accepts the model name as a parameter, for attributes all fields of the model are used.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -47,9 +63,16 @@ Or install it yourself as:
 $ gem install kadim
 ```
 
+Mount the engine:
+```ruby
+mount Kadim::Engine, at: '/kadim'
+```
+
+And access http://localhost:3000/kadim
+
 ## Roadmap
 - [x] Dynamic CRUD generation from application models
-- [ ] Tasks to copy files form kadim to the hosted application
+- [x] Tasks to copy files form kadim to the hosted application
 - [ ] Add support to ActiveStorage attachments
 - [ ] Add support to belongs_to relationships
 - [ ] Add a beautiful look and feel

data/app/helpers/kadim/application_helper.rb

@@ -3,7 +3,7 @@
 module Kadim
   module ApplicationHelper
     def menu_links
-      links = Kadim.app_model_names.map(&:camelize).map(&:constantize).map do |model_klass|
+      links = Kadim.app_model_paths.map(&:camelize).map(&:constantize).map do |model_klass|
         link_to model_klass.model_name.human(count: :many), model_klass
       end
       safe_join(links, " | ")

data/config/routes.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 Kadim::Engine.routes.draw do
-  Kadim.app_model_names.map(&:tableize).each do |table_name|
+  Kadim.app_model_paths.map(&:tableize).each do |table_name|
     resources table_name
   end
   root "application#index"

data/lib/generators/kadim/host/scaffold_controller/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Hosts on your application the files generated in runtime by `kadim` for the giving resource. This turns the
+    responsability for the resource to your application.
+
+    The model attributes are automatically detected by `kadim`.
+    resource.
+
+Example:
+    `rails generate kadim:host:scaffold_controller CreditCard`
+
+    This will create:
+        Credit card controller with URLs like /credit_cards.
+        Controller: app/controllers/credit_cards_controller.rb
+        Test:       test/controllers/credit_cards_controller_test.rb
+        Views:      app/views/credit_cards/index.html.erb [...]
+        Helper:     app/helpers/credit_cards_helper.rb

data/lib/generators/kadim/host/scaffold_controller/scaffold_controller_generator.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Kadim
+  module Host
+    class ScaffoldControllerGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def scaffold_controller
+        model_path = name.underscore
+        unless Kadim.app_model_paths.include?(model_path)
+          puts "Are you sure \"#{name}\" is a model?"
+          return
+        end
+
+
+        Rails::Generators.namespace = Kadim
+        generator = Rails::Generators::ScaffoldControllerGenerator.new(
+          [model_path, *Kadim.scaffold_attributes(model_path.camelize.constantize)],
+          ["--no-jbuilder", "--template-engine=erb"],
+          behavior: behavior,
+          destination_root: destination_root
+        )
+
+        # jbuilder 2.9.1 controller template uses a method removed from Rails6
+        # https://github.com/rails/jbuilder/issues/470
+        source_path_idx = generator.class.source_paths.index { |source_path| source_path.include?("jbuilder") }
+        generator.class.source_paths[source_path_idx] = generator.class.source_root if source_path_idx
+
+        generator.invoke_all
+      end
+    end
+  end
+end

data/lib/kadim/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kadim
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/lib/kadim.rb

@@ -1,17 +1,14 @@
 # frozen_string_literal: true
 
-require "rails/generators"
-require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
-
 require "kadim/engine"
 require "kadim/template/memory_resolver"
 
 module Kadim
-  def self.app_model_names
+  def self.app_model_paths
     Dir[Rails.root.join("app", "models", "**", "*.rb")]
       .reject { |model_path| model_path.include?("/concerns/") || model_path.include?("application_record") }
       .map    { |model_path| model_path.remove(%r{.*/app/models/}, ".rb") }
-      .select { |model_name| model_name.camelize.constantize.try(:table_exists?) }
+      .select { |model_path| model_path.camelize.constantize.try(:table_exists?) }
       .sort
   end
 
@@ -20,6 +17,15 @@ module Kadim
     scaffold_controllers
   end
 
+  def self.scaffold_attributes(model_klass)
+    model_klass.columns
+                .reject { |column| %w[id created_at updated_at].include?(column.name) }
+                .sort_by(&:name)
+                .map { |column| [column.name, column.type] }
+                .to_h
+                .map { |k, v| "#{k}:#{v}" }
+  end
+
   class << self
     private
       def cleanup
@@ -41,13 +47,16 @@ module Kadim
       end
 
       def controller_filenames
-        app_model_names.map { |model_name| "#{model_name.pluralize}_controller" }
+        app_model_paths.map { |model_name| "#{model_name.pluralize}_controller" }
       end
 
       def scaffold_controllers
+        Rails.application.load_generators
+        require "rails/generators/rails/scaffold_controller/scaffold_controller_generator"
+
         current_namespace = Rails::Generators.namespace
         Rails::Generators.namespace = Kadim
-        app_model_names.each { |model_name| scaffold_controller(model_name) }
+        app_model_paths.each { |model_name| scaffold_controller(model_name) }
         load_kadim_controllers
         load_kadim_views
       ensure
@@ -60,21 +69,14 @@ module Kadim
 
         generator = Rails::Generators::ScaffoldControllerGenerator.new(
           [model_name, *scaffold_attributes(model_klass)],
-          ["--force", "--quiet", "--no-orm", "--no-test-framework", "--no-helper"],
+          ["--force", "--quiet", "--no-test-framework", "--no-helper"],
           destination_root: Rails.root.join("tmp", "kadim")
         )
+        source_path_idx = generator.class.source_paths.index { |source_path| source_path.include?("jbuilder") }
+        generator.class.source_paths[source_path_idx] = generator.class.source_root if source_path_idx
         generator.invoke_all
       end
 
-      def scaffold_attributes(model_klass)
-        model_klass.columns
-                   .reject { |column| %w[id created_at updated_at].include?(column.name) }
-                   .sort_by(&:name)
-                   .map { |column| [column.name, column.type] }
-                   .to_h
-                   .map { |k, v| "#{k}:#{v}" }
-      end
-
       def load_kadim_controllers
         Dir[Rails.root.join("tmp", "kadim", "app", "controllers", "**", "*_controller.rb")].each { |path| load path }
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kadim
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Kadu Diógenes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-11-27 00:00:00.000000000 Z
+date: 2019-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activestorage-resumable
@@ -52,6 +52,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.29.0
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.16.1
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.7.3
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.10.5
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 4.2.0
+- !ruby/object:Gem::Dependency
+  name: rails-dom-testing
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.3
 - !ruby/object:Gem::Dependency
   name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
@@ -214,6 +284,8 @@ files:
 - config/routes.rb
 - lib/generators/kadim/host/USAGE
 - lib/generators/kadim/host/host_generator.rb
+- lib/generators/kadim/host/scaffold_controller/USAGE
+- lib/generators/kadim/host/scaffold_controller/scaffold_controller_generator.rb
 - lib/kadim.rb
 - lib/kadim/engine.rb
 - lib/kadim/template/memory_resolver.rb