hanami-cli_bulma 0.0.1

data/README.md

@@ -0,0 +1,61 @@
+# Hanami::CLI
+
+This gem adds support to [Bulma CSS Framework](https://bulma.io) for hanamai generators.
+
+NOTE:
+This library contains all of the CLI commands for [full-stack Hanami applications](`https://github.com/hanami/hanami`).
+
+## Contact
+
+- Home page: https://github.com/swilgosz/hanami-cli_bulma
+- Mailing List: [Hanami Mastery Newsletter](https://mailchi.mp/6ac8f64f3c5d/hanami-mastery-newsletter)
+- Bugs/Issues: https://github.com/swilgosz/hanami-cli_bulma/issues
+- API Doc: http://rubydoc.info/gems/hanami-cli_bulma
+- Chat: http://discourse.hanamirb.org
+
+## Installation
+
+**Hanami::CLIBulma** supports Ruby (MRI) 3.1+
+
+Add gem to your gemfile
+
+```shell
+# Gemfile
+gem 'hanami-cli_bulma'
+```
+
+```shell
+bundle install
+```
+
+## Usage
+
+```shell
+hanami g view users.show
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+In order to run all of the tests, you should run `docker compose up` separately, to run a `postgres` server.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/swilgosz/hanami-cli_bulma. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/swilgosz/hanami-cli_bulma/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the `Hanami::CLIBulma` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/swilgosz/hanami-cli_Bulma/blob/main/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Gem is extracted from `hanami-cli`, and managed by Sebastian Wilgosz
+
+Copyright © 2014–2024 Sebastian Wilgosz – Released under MIT License

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hanami-cli_bulma"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/docker-compose.yml

@@ -0,0 +1,14 @@
+services:
+  mysql:
+    image: mysql:latest
+    ports:
+      - 3307:3306
+    environment:
+      MYSQL_ROOT_PASSWORD: password
+  postgres:
+    image: postgres:latest
+    ports:
+      - 5433:5432
+    environment:
+      POSTGRES_USER: postgres
+      POSTGRES_PASSWORD: password

data/exe/hanami

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "hanami/cli_bulma"
+
+cli = Dry::CLI.new(Hanami::CLIBulma)
+# Hanami::CLIBulma::Bundler.require(:cli)
+
+begin
+  cli.call
+rescue Hanami::CLI::Error => exception
+  $stderr.puts(exception.message) # rubocop:disable Style/StderrPuts
+  exit(1)
+end

data/hanami-cli_bulma.gemspec

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require_relative "lib/hanami/cli_bulma/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "hanami-cli_bulma"
+  spec.version       = Hanami::CLIBulma::VERSION
+  spec.authors       = ["Sebastian Wilgosz"]
+  spec.email         = ["sebastian@hanamimastery.com"]
+
+  spec.summary       = "Hanami CLI generators extension for Bulma"
+  spec.description   = "Hanami command line Bulma CSS Framework integration"
+  spec.homepage      = "https://github.com/swilgosz/hanami-cli_bulma"
+  spec.license       = "MIT"
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/swilgosz/hanami-cli_bulma"
+  spec.metadata["changelog_uri"] = "https://github.com/swilgosz/hanami-cli_bulma/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+
+  # spec.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.metadata["rubygems_mfa_required"] = "true"
+  spec.required_ruby_version = ">= 3.1"
+
+  spec.add_dependency "bundler", "~> 2.1"
+  spec.add_dependency "hanami-cli", "= 2.2.0.beta2"
+  spec.add_dependency "zeitwerk", "~> 2.6"
+
+  spec.add_development_dependency "dry-inflector", "~> 1.0", "< 2"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "~> 1.0"
+end

data/lib/hanami/cli_bulma/bundler.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "bundler"
+require "open3"
+require "etc"
+
+module Hanami
+  module CLIBulma
+    # Conveniences for running `bundler` from CLI commands.
+    #
+    # @since 0.0.1
+    # @api public
+    class Bundler < Hanami::CLI::Bundler
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app/command.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "hanami/env"
+require_relative "db/utils/database"
+require_relative "../../files"
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module App
+        # Base class for `hanami` CLI commands intended to be executed within an existing Hanami
+        # app.
+        #
+        # @since 0.0.1
+        # @api public
+        class Command < Hanami::CLI::Commands::App::Command
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app/generate/action.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module App
+        module Generate
+          # @since 0.0.1
+          # @api private
+          class Action < Hanami::CLI::Commands::App::Generate::Action
+            # @since 0.0.1
+            # @api private
+            def initialize(
+              fs:, inflector:,
+              generator: Generators::App::Action.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              super(fs: fs, inflector: inflector, generator: generator, **opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app/generate/slice.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module App
+        module Generate
+          # @since 0.0.1
+          # @api private
+          class Slice < Hanami::CLI::Commands::App::Generate::Slice
+            # @since 0.0.1
+            # @api private
+            def initialize(
+              fs:, inflector:,
+              generator: Generators::App::Slice.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              super(fs: fs, inflector: inflector, generator: generator, **opts)
+              @generator = generator
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app/generate/view.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module App
+        module Generate
+          # @since 0.0.1
+          # @api private
+          class View < ::Hanami::CLI::Commands::App::Generate::View
+            def initialize(
+              fs:, inflector:,
+              generator: Generators::App::View.new(fs: fs, inflector: inflector),
+              **opts
+            )
+              super(fs: fs, inflector: inflector, generator: generator, **opts)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app/generate.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module App
+        # @since 0.0.1
+        # @api private
+        module Generate
+          require_relative "generate/slice"
+          require_relative "generate/action"
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/app.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      # Commands made available when the `hanami` CLI is executed within an Hanami app.
+      #
+      # @api private
+      # @since 0.0.1
+      module App
+        # @since 0.0.1
+        # @api private
+        def self.extended(base)
+          base.module_eval do
+            register "generate", aliases: ["g"] do |prefix|
+              prefix.register "slice", Generate::Slice
+              if Hanami.bundled?("hanami-controller")
+                prefix.register "action", Generate::Action
+              end
+
+              if Hanami.bundled?("hanami-view")
+                prefix.register "view", Generate::View
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/gem/new.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      module Gem
+        # @since 2.0.0
+        # @api private
+        class New < Hanami::CLI::Commands::Gem::New
+          # @since 2.0.0
+          # @api private
+          def initialize(
+            fs:, inflector:,
+            bundler: CLIBulma::Bundler.new(fs: fs),
+            generator: Generators::Gem::App.new(fs: fs, inflector: inflector),
+            system_call: Hanami::CLI::SystemCall.new,
+            **opts
+          )
+            super(fs: fs, inflector: inflector, **opts)
+            @bundler = bundler
+            @generator = generator
+            @system_call = system_call
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands/gem.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Hanami
+  module CLIBulma
+    module Commands
+      # Commands made available when the `hanami` CLI is executed outside of an Hanami app.
+      #
+      # @since 2.0.0
+      # @api public
+      module Gem
+        # @since 2.0.0
+        # @api private
+        def self.extended(base)
+          base.module_eval do
+            register "new", Commands::Gem::New
+          end
+        end
+      end
+    end
+  end
+end

data/lib/hanami/cli_bulma/commands.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'hanami/cli'
+
+module Hanami
+  module CLIBulma
+    # Contains the commands available for the current `hanami` CLI execution, depending on whether
+    # the CLI is executed inside or outside an Hanami app.
+    #
+    # @see .within_hanami_app?
+    #
+    # @api public
+    # @since 0.0.1
+    module Commands
+    end
+
+    # @api private
+    def self.register_commands!(within_hanami_app = within_hanami_app?)
+      commands =
+        if within_hanami_app
+          require "hanami/cli/commands/app"
+          extend(Hanami::CLI::Commands::App)
+
+          require_relative "commands/app"
+          extend(Hanami::CLIBulma::Commands::App)
+        else
+          require "hanami/cli/commands/gem"
+          extend(Hanami::CLI::Commands::Gem)
+
+          require_relative "commands/gem"
+          extend(Hanami::CLIBulma::Commands::Gem)
+        end
+    end
+  end
+end

data/lib/hanami/cli_bulma/generators/app/action/action.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module <%= camelized_app_name %>
+  module Actions
+<%= module_controller_declaration %>
+<%= module_controller_offset %>class <%= camelized_action_name %> < <%= camelized_app_name %>::Action
+<%- if bundled_views? -%>
+<%= module_controller_offset %>  def handle(request, response)
+<%- else -%>
+<%= module_controller_offset %>  def handle(request, response)
+<%= module_controller_offset %>    response.body = self.class.name
+<%- end -%>
+<%= module_controller_offset %>  end
+<%= module_controller_offset %>end
+<%= module_controller_end %>
+  end
+end

data/lib/hanami/cli_bulma/generators/app/action/slice_action.erb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module Actions
+<%= module_controller_declaration %>
+<%= module_controller_offset %>class <%= camelized_action_name %> < <%= camelized_slice_name %>::Action
+<%- if bundled_views? -%>
+<%= module_controller_offset %>  def handle(request, response)
+<%- else -%>
+<%= module_controller_offset %>  def handle(request, response)
+<%= module_controller_offset %>    response.body = self.class.name
+<%- end -%>
+<%= module_controller_offset %>  end
+<%= module_controller_offset %>end
+<%= module_controller_end %>
+  end
+end

data/lib/hanami/cli_bulma/generators/app/action.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "erb"
+
+# rubocop:disable Metrics/ParameterLists
+module Hanami
+  module CLIBulma
+    module Generators
+      module App
+        # @since 0.0.1
+        # @api private
+        class Action < Hanami::CLI::Generators::App::Action
+          def call(app, controller, action, url, http, format, skip_view, slice, context: nil)
+            context ||= Hanami::CLI::Generators::App::ActionContext.new(inflector, app, slice, controller, action)
+            if slice
+              generate_for_slice(controller, action, url, http, format, skip_view, slice, context)
+            else
+              generate_for_app(controller, action, url, http, format, skip_view, context)
+            end
+
+            view_directory = fs.join("app", "views", controller)
+            if generate_view?(skip_view, action, view_directory)
+              view_generator = Generators::App::View.new(fs: fs, inflector: inflector)
+              view_name = [controller, action].join(Hanami::CLI::Commands::App::Command::ACTION_SEPARATOR)
+              view_generator.call(app, view_name, format, slice)
+            end
+          end
+
+          private
+
+          # rubocop:disable Metrics/AbcSize
+          def generate_for_slice(controller, action, url, http, format, skip_view, slice, context)
+            slice_directory = fs.join("slices", slice)
+            raise Hanami::CLI::Errors::MissingSliceError.new(slice) unless fs.directory?(slice_directory)
+
+            fs.inject_line_at_block_bottom(
+              fs.join("config", "routes.rb"),
+              slice_matcher(slice),
+              route(controller, action, url, http)
+            )
+
+            fs.mkdir(directory = fs.join(slice_directory, "actions", controller))
+            fs.write(fs.join(directory, "#{action}.rb"), t("slice_action.erb", context))
+          end
+
+          def generate_for_app(controller, action, url, http, format, skip_view, context)
+            fs.inject_line_at_class_bottom(
+              fs.join("config", "routes.rb"),
+              "class Routes",
+              route(controller, action, url, http)
+            )
+
+            fs.mkdir(directory = fs.join("app", "actions", controller))
+            fs.write(fs.join(directory, "#{action}.rb"), t("action.erb", context))
+          end
+          # rubocop:enable Metrics/AbcSize
+
+          def template(path, context)
+            require "erb"
+
+            ERB.new(
+              File.read(__dir__ + "/action/#{path}"), trim_mode: "-",
+            ).result(context.ctx)
+          end
+
+          alias_method :t, :template
+        end
+      end
+    end
+  end
+end
+# rubocop:enable Metrics/ParameterLists

data/lib/hanami/cli_bulma/generators/app/slice/action.erb

@@ -0,0 +1,7 @@
+# auto_register: false
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  class Action < <%= camelized_app_name %>::Action
+  end
+end

data/lib/hanami/cli_bulma/generators/app/slice/app_css.erb

@@ -0,0 +1,7 @@
+@import "https://cdn.jsdelivr.net/npm/bulma@0.9.2/css/bulma.min.css";
+
+body {
+  background-color: #fff;
+  color: #000;
+  font-family: sans-serif;
+}

data/lib/hanami/cli_bulma/generators/app/slice/app_js.erb

@@ -0,0 +1 @@
+import "../css/app.css";

data/lib/hanami/cli_bulma/generators/app/slice/app_layout.erb

@@ -0,0 +1,46 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="UTF-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+    <title><%= humanized_app_name %> - <%= humanized_slice_name %></title>
+    <%- if bundled_assets? -%>
+    <%%= favicon_tag %>
+    <%= stylesheet_erb_tag %>
+    <%- end -%>
+  </head>
+  <body>
+    <nav class="navbar" role="navigation" aria-label="main navigation">
+      <div class="navbar-brand">
+        <a class="navbar-item" href="https://hanamimastery.com">
+          <img src="https://hanamimastery.com/logo-hm-letter.jpeg" height="28">
+        </a>
+      </div>
+      <div id="top-navigation" class="navbar-menu">
+        <div class="navbar-start">
+          <%%= link_to 'Home', '/', class: 'navbar-item' %>
+        </div>
+      </div>
+    </nav>
+
+    <section class="section">
+      <div class="container">
+        <%%= yield %>
+      </div>
+    </section>
+
+    <footer class="footer">
+      <div class="content has-text-centered">
+        <p>
+          <strong><%= humanized_app_name %></strong>. The source code is licensed
+          <a href="http://opensource.org/licenses/mit-license.php">MIT</a>. The website content
+          is licensed <a href="http://creativecommons.org/licenses/by-nc-sa/4.0/">CC BY NC SA 4.0</a>.
+        </p>
+      </div>
+    </footer>
+
+    <%- if bundled_assets? -%>
+    <%= javascript_erb_tag %>
+    <%- end -%>
+  </body>
+</html>

data/lib/hanami/cli_bulma/generators/app/slice/helpers.erb

@@ -0,0 +1,10 @@
+# auto_register: false
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module Views
+    module Helpers
+      # Add your view helpers here
+    end
+  end
+end

data/lib/hanami/cli_bulma/generators/app/slice/operation.erb

@@ -0,0 +1,7 @@
+# auto_register: false
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  class Operation < <%= camelized_app_name %>::Operation
+  end
+end

data/lib/hanami/cli_bulma/generators/app/slice/relation.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module DB
+    class Relation < <%= camelized_app_name %>::DB::Relation
+    end
+  end
+end

data/lib/hanami/cli_bulma/generators/app/slice/repo.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module DB
+    class Repo < <%= camelized_app_name %>::DB::Repo
+    end
+  end
+end

data/lib/hanami/cli_bulma/generators/app/slice/routes.erb

@@ -0,0 +1,3 @@
+
+slice :<%= underscored_slice_name %>, at: "<%= url %>" do
+end

data/lib/hanami/cli_bulma/generators/app/slice/struct.erb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module <%= camelized_slice_name %>
+  module DB
+    class Struct < <%= camelized_app_name %>::DB::Struct
+    end
+  end
+end