shepherd-rails 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a728e7d696c667e4674bddb3bcc691c8be34662ff082f3c54621be6e43ada88
+  data.tar.gz: 6dfebbf1006baf525767deb3245517759f74e02191d7389a71696671d0ec1761
+SHA512:
+  metadata.gz: e54bc3d14db62f7805ab1c155c2a2a1483400700c4d7e4b9ef4f75e2c5d3f3a2a8503eac0eea0988cfc294ba573ff8e29c7542df300f3f24220dd2cb6cf0db9e
+  data.tar.gz: 0b30ecac0b5b8b575f9757f06d6a65dd96110a3ca6a1c42812ac2c73978f8f6e1cc24aa9afe2931606bc359d794d545769ff42afe096d04151bc1fe822a3e2ba

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2023 Catalin Ionescu
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+# Shepherd-Rails
+A modern wrapper for using [Shepherd.js](https://shepherdjs.dev/) with Ruby on Rails.
+
+# Installation
+
+### 1. Add this line to your application's Gemfile:
+
+```ruby
+gem "shepherd-rails"
+```
+
+### 2. Then execute:
+```bash
+$ bundle
+```
+
+### 1.1. Or install it yourself as:
+```bash
+$ gem install shepherd-rails
+```
+
+### 3. Generate an initializer with:
+
+```bash
+bundle exec rails generate shepherd_rails
+```
+
+### 4. Then you need to install the JavaScript package:
+```bash
+$ yarn add shepherd-rails
+```
+
+### 5. Import the stimulus controller to your controllers entry-point (eg: _app/javascript/controllers/index.js_):
+```js
+import ShepherdRails from "shepherd-rails"
+application.register("shepherd-rails", ShepherdRails)
+```
+
+# Usage
+
+ShepherdRails is a fairly opinionated way to use ShepherdJs. If you have suggestions/requests for alternative flows, feel free open an issue.
+
+# Dependencies
+- [Stimulus](https://stimulus.hotwired.dev/)
+- [ShepherdJs](https://shepherdjs.dev/)
+
+# 🙏🏻 Contributing
+
+If you have an issue you'd like to submit, please do so using the issue tracker in GitHub. For us to help you in the best way possible, please be as detailed as you can.
+
+# 📝 License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/setup'
+
+APP_RAKEFILE = File.expand_path('spec/dummy/Rakefile', __dir__)
+load 'rails/tasks/engine.rake'
+
+load 'rails/tasks/statistics.rake'
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc 'Run all specs in spec directory (excluding plugin specs)'
+RSpec::Core::RakeTask.new(spec: 'app:db:test:prepare')
+
+task default: :spec

data/app/assets/config/sr_manifest.js

@@ -0,0 +1 @@
+//= link_directory ../stylesheets/sr .css

data/app/assets/stylesheets/sr/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
+ * files in this directory. Styles in this file should be added after the last require_* statement.
+ * It is generally better to create a new file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/shepherd_rails/application_controller.rb

@@ -0,0 +1,4 @@
+module ShepherdRails
+  class ApplicationController < ActionController::Base
+  end
+end

data/app/controllers/shepherd_rails/tour_statuses_controller.rb

@@ -0,0 +1,13 @@
+module ShepherdRails
+  class TourStatusesController < ShepherdRails.configuration.base_controller.constantize
+    def create
+      tour_name = params.require(:tour)
+      case params.require(:event)
+      when 'complete'
+        ShepherdRails.configuration.on_tour_complete.call(self, tour_name)
+      end
+
+      head :ok
+    end
+  end
+end

data/app/helpers/shepherd_rails/application_helper.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module ShepherdRails
+  module ApplicationHelper
+    def shepherd_tour tour:
+      tag.div nil, data: {
+        controller: 'shepherd-rails',
+        'shepherd-rails-tour-name-value' => tour,
+        'shepherd-rails-endpoint-value' => shepherd_rails.tour_statuses_path,
+        'shepherd-rails-config-value' => I18n.t(tour, scope: 'shepherd_rails')
+      }
+    end
+  end
+end

data/app/jobs/sr/application_job.rb

@@ -0,0 +1,4 @@
+module Sr
+  class ApplicationJob < ActiveJob::Base
+  end
+end

data/app/mailers/sr/application_mailer.rb

@@ -0,0 +1,6 @@
+module Sr
+  class ApplicationMailer < ActionMailer::Base
+    default from: "from@example.com"
+    layout "mailer"
+  end
+end

data/app/models/sr/application_record.rb

@@ -0,0 +1,5 @@
+module Sr
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+  end
+end

data/app/views/layouts/sr/application.html.erb

@@ -0,0 +1,15 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Sr</title>
+  <%= csrf_meta_tags %>
+  <%= csp_meta_tag %>
+
+  <%= stylesheet_link_tag    "sr/application", media: "all" %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,3 @@
+ShepherdRails::Engine.routes.draw do
+  resources :tour_statuses, only: [:create]
+end

data/config/shepherd_rails_initializer.rb

@@ -0,0 +1,4 @@
+ShepherdRails.configure do |config|
+  # config.on_tour_complete = ->(controller, tour_name) { controller.do_something tour_name }
+  # config.base_controller = 'ApplicationController'
+end

data/lib/generators/shepherd_rails_generator.rb

@@ -0,0 +1,8 @@
+class ShepherdRailsGenerator < Rails::Generators::Base
+  source_root File.expand_path('../..', __dir__)
+
+  desc 'Generate an initializer'
+  def create_initializer_file
+    copy_file 'config/shepherd_rails_initializer.rb', 'config/initializers/shepherd_rails.rb'
+  end
+end

data/lib/shepherd-rails/config.rb

@@ -0,0 +1,6 @@
+module ShepherdRails
+  class Config
+    cattr_accessor :on_tour_complete, default: ->(_ctx) { puts 'Here' }
+    cattr_accessor :base_controller, default: 'ActionController::Base'
+  end
+end

data/lib/shepherd-rails/engine.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module ShepherdRails
+  class Engine < ::Rails::Engine
+    isolate_namespace ShepherdRails
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.assets false
+      g.helper false
+    end
+
+    initializer 'shepherd_rails' do |app|
+      ActiveSupport.on_load :action_controller do
+        helper ShepherdRails::ApplicationHelper
+      end
+
+      app.routes.append do
+        mount ShepherdRails::Engine => '/shepherd-rails'
+      end
+    end
+  end
+end

data/lib/shepherd-rails/version.rb

@@ -0,0 +1,3 @@
+module ShepherdRails
+  VERSION = "0.0.1"
+end

data/lib/shepherd-rails.rb

@@ -0,0 +1,14 @@
+require 'shepherd-rails/version'
+require 'shepherd-rails/engine'
+require 'shepherd-rails/config'
+
+module ShepherdRails
+  class << self
+    attr_accessor :configuration
+
+    def configure
+      self.configuration ||= Config.new
+      yield(configuration)
+    end
+  end
+end

data/lib/tasks/shepherd_rails_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :sr do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: shepherd-rails
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Catalin Ionescu
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-03-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.0.0
+description: A modern wrapper for using Shepherd.js with Ruby on Rails
+email:
+- catalin.ionescu282@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/config/sr_manifest.js
+- app/assets/stylesheets/sr/application.css
+- app/controllers/shepherd_rails/application_controller.rb
+- app/controllers/shepherd_rails/tour_statuses_controller.rb
+- app/helpers/shepherd_rails/application_helper.rb
+- app/jobs/sr/application_job.rb
+- app/mailers/sr/application_mailer.rb
+- app/models/sr/application_record.rb
+- app/views/layouts/sr/application.html.erb
+- config/routes.rb
+- config/shepherd_rails_initializer.rb
+- lib/generators/shepherd_rails_generator.rb
+- lib/shepherd-rails.rb
+- lib/shepherd-rails/config.rb
+- lib/shepherd-rails/engine.rb
+- lib/shepherd-rails/version.rb
+- lib/tasks/shepherd_rails_tasks.rake
+homepage: https://github.com/cionescu/shepherd-rails
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/cionescu/shepherd-rails
+  source_code_uri: https://github.com/cionescu/shepherd-rails
+  changelog_uri: https://github.com/cionescu/shepherd-rails
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.7
+signing_key:
+specification_version: 4
+summary: A modern wrapper for using Shepherd.js with Ruby on Rails
+test_files: []