RubyGems - htmx-rails - Versions diffs - 0.0.0 → 0.1.0 - Mend

htmx-rails 0.0.0 → 0.1.0

Files changed (8) hide show

checksums.yaml +4 -4
data/README.md +17 -7
data/lib/assets/javascripts/htmx.js +1 -0
data/lib/generators/htmx/install_generator.rb +61 -0
data/lib/htmx-rails.rb +15 -0
data/lib/htmx/rails/version.rb +4 -1
metadata +27 -8
data/lib/htmx/rails.rb +0 -8

checksums.yaml CHANGED

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2a727a1cc17042ff04c774edbc378d03f29c62c01e33733373ca6d7b7996b50c
-  data.tar.gz: 978d16e758ed45c884e3b27e373722b92869aac1c693dcc666aabdad9b8cdac3
+  metadata.gz: 972f0b824831a04ea3f18e0021e091206f61b1a1c3951780601137ca59c89cd1
+  data.tar.gz: ff795bc5f41e4e1bed9382007007f2e59ba32ad46742f9920fe8f9f814d531e2
 SHA512:
-  metadata.gz: c937bd74e7f9303f0f98eaba4ade8e44054d9ce66e629c62d90265ba55ab6873be34ee74f4e863e7eed68b599e8e34c7d3aac3900e1cf32034622de49e1c0bee
-  data.tar.gz: 9fe86b33faf3c0b642102e327757f88323825df6b125a69e049ddabd632ba1b76732910bc46e57041017e6c043328ad3372f7d6f470ffa064cc68e8f122843f7
+  metadata.gz: bb8ceff768b6c0b4bfc4a52d3dd30f364fcb79fe8b23405fd815e4f50b4c59990bce3df9838cbaeeb01bf0b6956450f08c5a040ff0bdf4c63b3fea326fa258c5
+  data.tar.gz: 73dcdf6a9fb796a809c8092c599bfd2e8fe39dfb070629d3b3c9e7f7212746d6343313cf26662affef799ff22a7cd790f30885b917b2a652b9132d4e89a63b29

data/README.md CHANGED

@@ -1,12 +1,10 @@
 # Htmx::Rails
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/htmx/rails`. To experiment with that code, run `bin/console` for an interactive prompt.
-TODO: Delete this and the text above, and describe your gem
+[HTMX](https://htmx.org/) ruby gem for Ruby on Rails.
 ## Installation
-Add this line to your application's Gemfile:
+Add `htmx-rails` to your `Gemfile`:
 ```ruby
 gem 'htmx-rails'
@@ -20,9 +18,21 @@ Or install it yourself as:
     $ gem install htmx-rails
+After installing the gem, run the installer:
+    $ rails g htmx:install
 ## Usage
-TODO: Write usage instructions here
+```HTML
+<!-- have a button POST via AJAX -->
+<button hx-post="/clicked" hx-swap="outerHTML">
+  Click Me
+</button>
+```
+### Read the [docs](https://htmx.org/docs/) for a more in-depth introduction.
 ## Development
@@ -32,7 +42,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/[USERNAME]/htmx-rails. 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/[USERNAME]/htmx-rails/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rootstrap/htmx-rails. 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/rootstrap/htmx-rails/blob/master/CODE_OF_CONDUCT.md).
 ## License
@@ -41,4 +51,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
-Everyone interacting in the Htmx::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/htmx-rails/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Htmx::Rails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rootstrap/htmx-rails/blob/master/CODE_OF_CONDUCT.md).

data/lib/assets/javascripts/htmx.js ADDED

@@ -0,0 +1 @@

data/lib/generators/htmx/install_generator.rb ADDED

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+module Htmx
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      WEBPACKER_SETUP = "require('htmx.org')\n"
+      SPROCKETS_SETUP = "//= require htmx\n"
+      desc 'Prep application.js to include HTMX installation for Webpacker or Sprockets'
+      # Setup HTMX
+      def setup
+        if webpacker?
+          setup_webpacker
+        else
+          setup_sprockets
+        end
+      end
+      private
+      def webpacker?
+        !!defined?(Webpacker)
+      end
+      def manifest(javascript_dir)
+        Pathname.new(destination_root).join(javascript_dir, 'application.js')
+      end
+      def setup_sprockets
+        manifest = manifest('app/assets/javascripts')
+        if manifest.exist?
+          append_file manifest, "\n#{SPROCKETS_SETUP}"
+        else
+          create_file manifest, SPROCKETS_SETUP
+        end
+      end
+      def setup_webpacker
+        `yarn add htmx.org`
+        manifest = manifest(webpack_source_path)
+        if manifest.exist?
+          append_file(manifest, "\n#{WEBPACKER_SETUP}")
+        else
+          create_file(manifest, WEBPACKER_SETUP)
+        end
+      end
+      def webpack_source_path
+        (Webpacker.try(:config).try(:source_entry_path) ||
+          Webpacker::Configuration.source_path.join(
+            Webpacker::Configuration.entry_path
+          )
+        ).relative_path_from(::Rails.root).to_s
+      end
+    end
+  end
+end

data/lib/htmx-rails.rb ADDED

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+# Rails Core
+require 'active_support/core_ext/hash'
+require 'rails/generators'
+# Files
+require 'generators/htmx/install_generator'
+require 'htmx/rails/version'
+module Htmx
+  module Rails
+    class Error < StandardError; end
+  end
+end

data/lib/htmx/rails/version.rb CHANGED

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
 module Htmx
   module Rails
-    VERSION = '0.0.0'.freeze
+    VERSION = '0.1.0'
+    HTMX_VERSION = '1.0.2'
   end
 end

metadata CHANGED

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: htmx-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.1.0
 platform: ruby
 authors:
 - Julian Pasquale
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-12-11 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: generator_spec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,21 +94,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.17.1
-description: ''
+description: Ruby gem for use HTMX in Rails applications
 email:
-- julianagustin78@gmail.com
+- julian.pasquale@rootstrap.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE.txt
 - README.md
-- lib/htmx/rails.rb
+- lib/assets/javascripts/htmx.js
+- lib/generators/htmx/install_generator.rb
+- lib/htmx-rails.rb
 - lib/htmx/rails/version.rb
-homepage: ''
+homepage: https://github.com/rootstrap/htmx-rails
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/rootstrap/htmx-rails
+  source_code_uri: https://github.com/rootstrap/htmx-rails
+  changelog_uri: https://github.com/rootstrap/htmx-rails
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -113,5 +132,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key:
 specification_version: 4
-summary: ''
+summary: Ruby gem for use HTMX in Rails applications
 test_files: []

data/lib/htmx/rails.rb DELETED

@@ -1,8 +0,0 @@
-require 'htmx/rails/version'
-module Htmx
-  module Rails
-    class Error < StandardError; end
-    # Your code goes here...
-  end
-end