next_rails_scaffold 0.1.9 → 0.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9e43c5ca53fb69e1b2ad36d222316f092d83adcf22771de34838c9b176c5aa1
-  data.tar.gz: 383a69fa52d27c05645ae3db30a9e36a8b628ea7fab6f7c29dfc7c9c40162824
+  metadata.gz: f03d199ec6a029410c9c0626e7eaa604e8e454c772b161a5ef884e5503d4e284
+  data.tar.gz: c0c56ac0d95b65e3979c0120f59db0f494a980fdcd8f4138c037b74ce43aff5c
 SHA512:
-  metadata.gz: 0fc1ab34055af28a30ba72b57d9e1c9e59aec332dc6e1e8c4a141537193d2fe11a8ba7f554e79f75e760eca6ffc2765ba055453c250218da22de0f653fddb546
-  data.tar.gz: beddbe982618623580da842ee049380f033739eb6dc5b1039ee6c342be06ecf37c890da19c938cf09053bde8049c9e40fb0fad556791707a157eb29deb5ada96
+  metadata.gz: 8b3369a429e58f2739888d89ef20fa368124b27e5cfcd302eaedc9d09173391ef42a46ce3d99be58320a3fb22782e92545182b3ff19e160c162f3aed34d3750c
+  data.tar.gz: 87dcb6bc580cc1a9aa8afd0aa0314ff037ae0d7f31cad7a35a653862f46ea3f4c472f84a6faabc8c2780d95e7bf7905e8cbe03811345f414492eef05b514bd1e

data/README.md

@@ -1,10 +1,21 @@
-# NextRails
+# NextRailsScaffold
 
 The `next_rails_scaffold` gem is a powerful extension to the standard Ruby on Rails scaffold generator. It streamlines the development workflow by not only creating the backend structure with Rails but also automating the setup of a frontend directory using Next.js. Upon running the scaffold generator, this gem intelligently generates a Next.js application within the specified frontend directory.
 
 The generated Next.js app follows best practices, including a structured page routing system, ensuring that each resource created by the scaffold has its corresponding page and components. This integration enables developers to seamlessly transition between Rails backend and Next.js frontend development, fostering a cohesive and efficient development environment.
 
-Key Features:
+Currently, https://www.hygen.io/ is used to create Next.js code, and the https://github.com/raphox/next-rails-scaffold repository contains template files.
+
+<div align="center">
+  <a href="https://www.youtube.com/watch?v=eMM3AChZ5LY" target="_blank">
+    <img
+      src="https://img.youtube.com/vi/eMM3AChZ5LY/0.jpg"
+      alt="NextRailsScaffold (next_rails_scaffold)"
+      style="width:60%">
+  </a>
+</div>
+
+## Key Features:
 
 - **Automatic Frontend Setup:** The gem automates the creation of a frontend directory within the Rails project, ready for Next.js development.
 - **Page Routing Integration:** All scaffolded resources come with their own pages and components, organized using Next.js' page routing system.
@@ -30,6 +41,10 @@ The `next_rails_scaffold` gem enhances the default Ruby on Rails scaffold genera
 Example:
 
 ```
+# Appending the `next_rails_scaffold` generator steps to the  to the Rails' scaffold generator.
+bin/rails generate next_rails_scaffold:install
+
+# Generate the RESfull API endpoints and Next.js app with respective components and pages.
 bin/rails generate scaffold Post tile:string body:text
 ```
 
@@ -57,6 +72,8 @@ frontend/
       services.js
 ```
 
+Sample app https://github.com/raphox/next-rails-app.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -65,7 +82,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/raphox/next_rails.
+Bug reports and pull requests are welcome on GitHub at https://github.com/raphox/next_rails_scaffold.
 
 ## License
 

data/app/controllers/{next_rails → next_rails_scaffold}/static_pages_controller.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NextRails
+module NextRailsScaffold
   class StaticPagesController < ApplicationController
     STATIC_FILES_PATH = Rails.root.join("public").to_s
 

data/config/routes.rb

@@ -11,6 +11,6 @@ Rails.application.routes.draw do
     route = path[%r{#{Regexp.escape(static_files_path)}(.*)/index.html}, 1]
     route = route.gsub(parameter_regex, ':\1')
 
-    get route, to: "next_rails/static_pages#index", file_path: path
+    get route, to: "next_rails_scaffold/static_pages#index", file_path: path
   end
 end

data/lib/generators/{next_rails → next_rails_scaffold}/install_generator.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-module NextRails
+module NextRailsScaffold
   module Generators
     class InstallGenerator < Rails::Generators::Base
-      desc "Copy NextRails default files"
+      desc "Copy NextRailsScaffold default files"
       source_root File.expand_path("templates", __dir__)
 
       def copy_config
-        template "config/initializers/next_rails.rb"
+        template "config/initializers/next_rails_scaffold.rb"
       end
     end
   end

data/lib/generators/{next_rails/templates/config/initializers/next_rails.rb → next_rails_scaffold/templates/config/initializers/next_rails_scaffold.rb}

@@ -1,11 +1,9 @@
 # frozen_string_literal: true
 
-require "next_rails"
-
-NextRails.setup do |config|
+NextRailsScaffold.setup do |config|
   config.generators do |g|
     g.api_only = true
     g.resource_route false
-    g.helper :next_rails
+    g.helper :next_rails_scaffold
   end
 end

data/lib/generators/rails/{next_rails/next_rails_generator.rb → next_rails_scaffold/next_rails_scaffold_generator.rb}

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
 module Rails
-  class NextRailsGenerator < Rails::Generators::NamedBase
-    include ::NextRails::Actions
+  class NextRailsScaffoldGenerator < Rails::Generators::NamedBase
+    include ::NextRailsScaffold::Actions
 
     source_root File.expand_path("templates", __dir__)
 
@@ -50,7 +50,7 @@ module Rails
         create_next_app!
         install_hygen!
 
-        run("npx hygen generator scaffold #{name} #{mapped_attributes.join(" ")}")
+        run("npx hygen scaffold javascript #{name} #{mapped_attributes.join(" ")}")
         run("yarn build")
       end
     end

data/lib/{next_rails → next_rails_scaffold}/actions.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-module NextRails
+module NextRailsScaffold
   module Actions
     # Make an entry in Rails routing file <tt>config/routes.rb</tt>
     #

data/lib/next_rails_scaffold/engine.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module NextRailsScaffold
+  class Engine < ::Rails::Engine
+    isolate_namespace NextRailsScaffold
+    config.eager_load_namespaces << NextRailsScaffold
+  end
+end

data/lib/next_rails_scaffold/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NextRailsScaffold
+  VERSION = "0.1.11"
+end

data/lib/{next_rails.rb → next_rails_scaffold.rb}

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require_relative "next_rails/actions"
-require_relative "next_rails/engine"
-require_relative "next_rails/version"
+require_relative "next_rails_scaffold/actions"
+require_relative "next_rails_scaffold/engine"
+require_relative "next_rails_scaffold/version"
 
-module NextRails
+module NextRailsScaffold
   class Error < StandardError; end
 
   @@configured = false
@@ -13,7 +13,7 @@ module NextRails
     @@configured
   end
 
-  # Default way to setup Next Rails. Run rails generate next_rails:install
+  # Default way to setup Next Rails. Run rails generate next_rails_scaffold:install
   # to create a fresh initializer with all configuration values.
   def self.setup
     @@configured = true

data/sig/{next_rails.rbs → next_rails_scaffold.rbs}

@@ -1,4 +1,4 @@
-module NextRails
+module NextRailsScaffold
   VERSION: String
   # See the writing guide of rbs: https://github.com/ruby/rbs#guides
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: next_rails_scaffold
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.1.11
 platform: ruby
 authors:
 - Raphael Araújo
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2023-11-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -50,17 +50,17 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- app/controllers/next_rails/static_pages_controller.rb
+- app/controllers/next_rails_scaffold/static_pages_controller.rb
 - config/routes.rb
-- lib/generators/next_rails/USAGE
-- lib/generators/next_rails/install_generator.rb
-- lib/generators/next_rails/templates/config/initializers/next_rails.rb
-- lib/generators/rails/next_rails/next_rails_generator.rb
-- lib/next_rails.rb
-- lib/next_rails/actions.rb
-- lib/next_rails/engine.rb
-- lib/next_rails/version.rb
-- sig/next_rails.rbs
+- lib/generators/next_rails_scaffold/USAGE
+- lib/generators/next_rails_scaffold/install_generator.rb
+- lib/generators/next_rails_scaffold/templates/config/initializers/next_rails_scaffold.rb
+- lib/generators/rails/next_rails_scaffold/next_rails_scaffold_generator.rb
+- lib/next_rails_scaffold.rb
+- lib/next_rails_scaffold/actions.rb
+- lib/next_rails_scaffold/engine.rb
+- lib/next_rails_scaffold/version.rb
+- sig/next_rails_scaffold.rbs
 homepage: https://github.com/raphox/next-rails#readme
 licenses:
 - MIT

data/lib/next_rails/engine.rb

@@ -1,8 +0,0 @@
-# frozen_string_literal: true
-
-module NextRails
-  class Engine < ::Rails::Engine
-    isolate_namespace NextRails
-    config.eager_load_namespaces << NextRails
-  end
-end

data/lib/next_rails/version.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-module NextRails
-  VERSION = "0.1.9"
-end