stimulant 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 11c20750708a193a5311b75687287e8ee16fc750b2909f193dae5a7d882fae11
+  data.tar.gz: ebb56b60eccf6b1f695576d2b23face08f23cfa39543ed2c5daa2ef3e7d4a10f
+SHA512:
+  metadata.gz: b4d0a16064f5df113ce16fb2c07c04f8c6621345670bc2a48d718bcd9d8502ad6fd5ade4824103f022279e7fd336687f4fdf0ea2239ecb443d144408b23ca924
+  data.tar.gz: a5c115f160fba2f1ad992c81002a87cfe63b217ffcc7a3263a70d0dffcf9015139152663ffc9a2fc7790229d1529dbaa14c45c6cd646e4d1e15e1b71f89cb58c

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea
+

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+inherit_gem:
+  onkcop:
+    - "config/rubocop.yml"
+
+AllCops:
+  TargetRubyVersion: 2.5
+Style/AccessModifierDeclarations:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,13 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+install:
+  - bundle install
+script:
+  - bundle exec rubocop
+  - bundle exec rake test
+rvm:
+  - 2.5.5
+  - 2.6.2
+before_install: gem install bundler -v 2.0.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at en30.git@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,13 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in stimulant.gemspec
+gemspec
+
+gem "onkcop", "~> 0.53", require: false
+gem "rails"
+gem "rake", ">= 11.0"
+gem "rubocop", "~> 0.66", require: false
+
+group :test do
+  gem "minitest", "~> 5.0"
+end

data/Gemfile.lock

@@ -0,0 +1,154 @@
+PATH
+  remote: .
+  specs:
+    stimulant (0.1.0)
+      activesupport (>= 5.1)
+      railties (>= 5.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (5.2.3)
+      actionpack (= 5.2.3)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailer (5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (5.2.3)
+      activesupport (= 5.2.3)
+      globalid (>= 0.3.6)
+    activemodel (5.2.3)
+      activesupport (= 5.2.3)
+    activerecord (5.2.3)
+      activemodel (= 5.2.3)
+      activesupport (= 5.2.3)
+      arel (>= 9.0)
+    activestorage (5.2.3)
+      actionpack (= 5.2.3)
+      activerecord (= 5.2.3)
+      marcel (~> 0.3.1)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    arel (9.0.0)
+    ast (2.4.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    erubi (1.8.0)
+    globalid (0.4.2)
+      activesupport (>= 4.2.0)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.2)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (0.3.3)
+      mimemagic (~> 0.3.2)
+    method_source (0.9.2)
+    mimemagic (0.3.3)
+    mini_mime (1.0.1)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    nio4r (2.3.1)
+    nokogiri (1.10.2)
+      mini_portile2 (~> 2.4.0)
+    onkcop (0.53.0.3)
+      rubocop (>= 0.53.0)
+      rubocop-rspec (>= 1.24.0)
+    parallel (1.16.2)
+    parser (2.6.2.0)
+      ast (~> 2.4.0)
+    psych (3.1.0)
+    rack (2.0.6)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (5.2.3)
+      actioncable (= 5.2.3)
+      actionmailer (= 5.2.3)
+      actionpack (= 5.2.3)
+      actionview (= 5.2.3)
+      activejob (= 5.2.3)
+      activemodel (= 5.2.3)
+      activerecord (= 5.2.3)
+      activestorage (= 5.2.3)
+      activesupport (= 5.2.3)
+      bundler (>= 1.3.0)
+      railties (= 5.2.3)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (5.2.3)
+      actionpack (= 5.2.3)
+      activesupport (= 5.2.3)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.19.0, < 2.0)
+    rainbow (3.0.0)
+    rake (12.3.2)
+    rubocop (0.66.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.5, != 2.5.1.1)
+      psych (>= 3.1.0)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.6)
+    rubocop-rspec (1.32.0)
+      rubocop (>= 0.60.0)
+    ruby-progressbar (1.10.0)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.5.0)
+    websocket-driver (0.7.0)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  minitest (~> 5.0)
+  onkcop (~> 0.53)
+  rails
+  rake (>= 11.0)
+  rubocop (~> 0.66)
+  stimulant!
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 en30
+
+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,61 @@
+# Stimulant
+
+Helper to integrate Stimulus into Rails application.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'stimulant'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stimulant
+
+## Usage
+stimulant adds a helper method `stimulus_scope`.
+
+```erbruby
+<%= stimulus_scope :slideshow do |s| %>
+  <div data-controller="<%= s.controller %>" data-action="<%= s.action(:next, on: "slideshow:next", at: "window)>
+    <div data-target="<%= s.target(:slide) %>">
+      <button data-action="<%= s.action(:next) + s.action(:hoge) %>">next</button>
+    </div>
+  </div>
+<% end %>
+```
+
+becomes
+
+```html
+<div data-controller="slidedhow" data-action="slidedhow:next@window->slideshow#next">
+  <div data-target="slideshow.slide">
+    <button data-action="slidedhow#next slideshow#hoge">next</button>
+  </div>
+</div>
+```
+
+
+## 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 tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/en30/stimulant. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## 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 Stimulant project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/stimulant/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "stimulant"
+
+# 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/lib/stimulant.rb

@@ -0,0 +1,16 @@
+require "stimulant/version"
+
+module Stimulant
+  class UnusedScopeError < StandardError; end
+  # Your code goes here...
+end
+
+require "stimulant/data"
+require "stimulant/scope"
+require "stimulant/helper"
+require "stimulant/list"
+require "stimulant/controller"
+require "stimulant/action"
+require "stimulant/target"
+
+require "stimulant/railtie" if defined?(Rails)

data/lib/stimulant/action.rb

@@ -0,0 +1,32 @@
+module Stimulant
+  class Action
+    attr_reader :controller, :name, :event, :source
+    private :controller
+    private :name
+    private :event
+    private :source
+
+    def initialize(controller, name, event: nil, source: nil)
+      @controller = controller
+      @event = event
+      @source = source
+      @name = name.to_s.underscore.camelize(:lower)
+    end
+
+    def to_s
+      s = "#{controller}##{name}"
+      s = "#{trigger}->#{s}" unless trigger.nil?
+      s
+    end
+
+    private
+
+      def trigger
+        return nil if event.nil?
+
+        res = event.to_s
+        res += "@#{source}" unless source.nil?
+        res
+      end
+  end
+end

data/lib/stimulant/controller.rb

@@ -0,0 +1,14 @@
+module Stimulant
+  class Controller
+    attr_reader :name, :data
+
+    def initialize(name, data: {})
+      @name = name.to_s.underscore.tr("_", "-")
+      @data = data.transform_keys {|k| :"#{name}-#{k.to_s.underscore.tr("_", "-")}" }
+    end
+
+    def to_s
+      name
+    end
+  end
+end

data/lib/stimulant/data.rb

@@ -0,0 +1,9 @@
+module Stimulant
+  class Data < Hash
+    def +(other)
+      merge(other) do |_key, oldval, newval|
+        oldval + newval
+      end
+    end
+  end
+end

data/lib/stimulant/helper.rb

@@ -0,0 +1,11 @@
+module Stimulant
+  module Helper
+    def stimulus_scope(controller, **data, &block)
+      scope = Scope.new(controller, data: data)
+      res = capture(scope, &block)
+      raise UnusedScopeError unless scope.controller_used?
+
+      res
+    end
+  end
+end

data/lib/stimulant/list.rb

@@ -0,0 +1,22 @@
+module Stimulant
+  class List
+    attr_reader :items
+    protected :items
+
+    def initialize(*items)
+      @items = items
+    end
+
+    def +(other)
+      List.new(*(@items + other.items))
+    end
+
+    def to_s
+      items.join(" ")
+    end
+
+    def to_json(_opts = nil)
+      items.map(&:to_s).join(" ")
+    end
+  end
+end

data/lib/stimulant/railtie.rb

@@ -0,0 +1,11 @@
+require "rails/railtie"
+
+require "stimulant/helper"
+
+class Stimulant::Railtie < ::Rails::Engine
+  initializer "stimulant.helper" do
+    ActiveSupport.on_load :action_view do
+      include Stimulant::Helper
+    end
+  end
+end

data/lib/stimulant/scope.rb

@@ -0,0 +1,33 @@
+module Stimulant
+  class Scope
+    def initialize(controller, data: {})
+      @controller = Controller.new(controller, data: data)
+      @controller_used = false
+    end
+
+    def controller
+      @controller_used = true
+      List.new(@controller)
+    end
+
+    def root_data
+      Data[[[:controller, controller]] + data.entries]
+    end
+
+    def data
+      Data[@controller.data.entries]
+    end
+
+    def target(name)
+      List.new(Target.new(@controller, name))
+    end
+
+    def action(name, on: nil, at: nil)
+      List.new(Action.new(@controller, name, event: on, source: at))
+    end
+
+    def controller_used?
+      @controller_used
+    end
+  end
+end

data/lib/stimulant/target.rb

@@ -0,0 +1,16 @@
+module Stimulant
+  class Target
+    attr_reader :controller, :name
+    private :controller
+    private :name
+
+    def initialize(controller, name)
+      @controller = controller
+      @name = name.to_s.underscore.camelize(:lower)
+    end
+
+    def to_s
+      "#{controller}.#{name}"
+    end
+  end
+end

data/lib/stimulant/version.rb

@@ -0,0 +1,3 @@
+module Stimulant
+  VERSION = "0.1.0".freeze
+end

data/stimulant.gemspec

@@ -0,0 +1,27 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "stimulant/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "stimulant"
+  spec.version       = Stimulant::VERSION
+  spec.authors       = ["en30"]
+  spec.email         = ["en30.git@gmail.com"]
+
+  spec.summary       = "Helper to integrate Stimulus into Rails application"
+  spec.homepage      = "https://github.com/en30/stimulant"
+  spec.license       = "MIT"
+
+  # 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{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activesupport", ">= 5.1"
+  spec.add_dependency "railties",      ">= 5.1"
+  spec.add_development_dependency "bundler", "~> 2.0"
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: stimulant
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- en30
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: 
+email:
+- en30.git@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/stimulant.rb
+- lib/stimulant/action.rb
+- lib/stimulant/controller.rb
+- lib/stimulant/data.rb
+- lib/stimulant/helper.rb
+- lib/stimulant/list.rb
+- lib/stimulant/railtie.rb
+- lib/stimulant/scope.rb
+- lib/stimulant/target.rb
+- lib/stimulant/version.rb
+- stimulant.gemspec
+homepage: https://github.com/en30/stimulant
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Helper to integrate Stimulus into Rails application
+test_files: []