remove_data_attributes 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8f452b99f8cf397d4fe5847d5ba2acc358b0a4f9
-  data.tar.gz: 6fd3924500e127fbea0e3e24a7aaafd10c1f0921
+  metadata.gz: 69172fe3cb093195772529974892d07ac0b1d025
+  data.tar.gz: fbb4df2602315e76d4dea5bda7b5e57eacea462f
 SHA512:
-  metadata.gz: 1f9ef7647b704567c48f3f48e2b99754e14b5e8f3787c6aa64d19b8e183b2eec07eb345ccb28573f769172a57ca9fb815943d1cad51721c958962c3c8ee98278
-  data.tar.gz: 2a8ed8b6044246b76c13d4d13e1ddfb92d0d7a605ba8e2597617199679db79735351de888a57c8012fc5892a743bd675c4c68196ed27b26fc0d948ce9f2061af
+  metadata.gz: c24bd87c412edf0fec11d8eef4d1211b94ee4b4c73877ca4a66c8eddf91001a1604ebd145749dcb255918228ea5b9d3b9ad285b38fe47ace7df0ce9fb827b290
+  data.tar.gz: 62dc161345a0f579baad575c02537dad0bf4a9c05c01db61b9a5c1dc3fb0a4acf68b48807755e03d6e8b56752fbcd894558f49bb7d8a0c22e45c0f36ae589181

data/CHANGELOG.md

@@ -1,3 +1,9 @@
 # CHANGELOG
+## [0.2.0](https://github.com/yasaichi/remove_data_attributes/releases/tag/v0.2.0) (December 26, 2017)
+* [Write README](https://github.com/yasaichi/remove_data_attributes/pull/8)
+* [Use YAML for the configuration](https://github.com/yasaichi/remove_data_attributes/pull/7)
+* [Implement a generator of the configuration file](https://github.com/yasaichi/remove_data_attributes/pull/6)
+* [Change dependency from `rails` to `railties`](https://github.com/yasaichi/remove_data_attributes/pull/5)
+
 ## [0.1.0](https://github.com/yasaichi/remove_data_attributes/releases/tag/v0.1.0) (December 10, 2017)
 * The initial release to reserve the gem name

data/MIT-LICENSE

@@ -1,4 +1,4 @@
-Copyright 2017 yasaichi
+Copyright 2017 Yuichi Goto
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,14 +1,22 @@
-# RemoveDataAttributes
-Short description and motivation.
+# remove\_data\_attributes
+[![Gem Version](https://badge.fury.io/rb/remove_data_attributes.svg)](https://badge.fury.io/rb/remove_data_attributes)
+[![Build Status](https://travis-ci.org/yasaichi/remove_data_attributes.svg?branch=master)](https://travis-ci.org/yasaichi/remove_data_attributes)
+[![Maintainability](https://api.codeclimate.com/v1/badges/eddaa55a25ccd62b9eb8/maintainability)](https://codeclimate.com/github/yasaichi/remove_data_attributes/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/eddaa55a25ccd62b9eb8/test_coverage)](https://codeclimate.com/github/yasaichi/remove_data_attributes/test_coverage)
 
-## Usage
-How to use my plugin.
+## Motivation
+As described in [this post](https://blog.kentcdodds.com/making-your-ui-tests-resilient-to-change-d37a6ee37269), using data attributes as selector makes your UI tests more resilient to change.  
+However, there is one little problem in this way: these attributes are useless when running your application in production.
+
+## Solution (with limitations)
+remove_data_attributes is a plugin for Ruby on Rails like [babel-plugin-react-remove-properties](https://github.com/oliviertassinari/babel-plugin-react-remove-properties) for Babel.  
+Note that the plugin can remove __only the data attributes passed into the view helpers__, because there is no room to parse and remove all attributes (including ones embedded in HTML tags) in advance unlike the Babel plugin.
 
 ## Installation
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'remove_data_attributes'
+gem 'remove_data_attributes', group: :production
 ```
 
 And then execute:
@@ -16,13 +24,68 @@ And then execute:
 $ bundle
 ```
 
-Or install it yourself as:
-```bash
-$ gem install remove_data_attributes
+## Usage
+Run the installation generator with:
+
+```sh
+$ rails generate remove_data_attributes:install
+```
+
+And then specify `data-*` attributes you'd like to remove in the generated configuration file:
+
+```yaml
+data_attributes:
+  - data-test
+```
+
+This will remove `data-test` attributes.
+
+## Example
+Here is an example of removing `data-test` attributes.
+
+### Template
+```ERB
+<%= form_for :user, url: session_path(:user) do |f| %>
+  <%= field_set_tag "Email" do %>
+    <%= f.email_field :email, "data-test": "email" %>
+  <% end %>
+
+  <%= field_set_tag "Password" do %>
+    <%= f.password_field :password, "data-test" => "password" %>
+  <% end %>
+
+  <%= f.submit "Sign in", data: { test: "submit" } %>
+<% end %>
+```
+
+### Rendered HTML (formatted for readability)
+```html
+<form action="/users/sign_in" accept-charset="UTF-8" method="post">
+  <input name="utf8" type="hidden" value="&#x2713;" />
+  <input type="hidden" name="authenticity_token" value="HyOvLlyjIh7Sv7fFt2fKy5+uJNeKwnYobQPs49pl/H7CKSAVrw57jxpERJihR+B77GNSh2pZHG5mEWl0ieYQnQ==" />
+
+  <fieldset>
+    <legend>Email</legend>
+    <input type="email" value="" name="user[email]" id="user_email" />
+  </fieldset>
+
+  <fieldset>
+    <legend>Password</legend>
+    <input type="password" name="user[password]" id="user_password" />
+  </fieldset>
+
+  <input type="submit" name="commit" value="Sign in" data-disable-with="Sign in" />
+</form>
 ```
 
 ## Contributing
-Contribution directions go here.
+You should follow the steps below:
+
+1. [Fork the repository](https://help.github.com/articles/fork-a-repo/)
+2. Create a feature branch: `git checkout -b add-new-feature`
+3. Commit your changes: `git commit -am 'Add new feature'`
+4. Push the branch: `git push origin add-new-feature`
+4. [Send us a pull request](https://help.github.com/articles/about-pull-requests/)
 
 ## License
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -16,9 +16,8 @@ RDoc::Task.new(:rdoc) do |rdoc|
   rdoc.rdoc_files.include("lib/**/*.rb")
 end
 
-
-
-
-
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
 
 require "bundler/gem_tasks"

data/lib/generators/remove_data_attributes/install/USAGE

@@ -0,0 +1,8 @@
+Description:
+    Creates a configuration file of remove_data_attributes.
+
+Example:
+    `rails generate remove_data_attributes:install`
+
+    This will create:
+        config/remove_data_attributes.yml

data/lib/generators/remove_data_attributes/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module RemoveDataAttributes
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root ::File.expand_path("../templates", __FILE__)
+
+      def copy_configuration_file
+        copy_file "remove_data_attributes.yml", "config/remove_data_attributes.yml"
+      end
+    end
+  end
+end

data/lib/generators/remove_data_attributes/install/templates/remove_data_attributes.yml

@@ -0,0 +1,3 @@
+# Configure which data attributes should be removed.
+data_attributes:
+  # - data-test

data/lib/remove_data_attributes.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
 
-require "remove_data_attributes/configuration"
 require "remove_data_attributes/railtie"
 require "remove_data_attributes/version"

data/lib/remove_data_attributes/configuration.rb

@@ -1,20 +1,49 @@
 # frozen_string_literal: true
 
+require "remove_data_attributes/errors"
+require "yaml"
+
 module RemoveDataAttributes
-  class << self
-    attr_writer :configuration
+  class Configuration
+    SUPPORTED_FILE_FORMATS = {
+      "YAML" => [".yml", ".yaml"].freeze
+    }.freeze
 
-    def configuration
-      @configuration ||= ::RemoveDataAttributes::Configuration.new
-    end
+    attr_writer :data_attributes
+
+    class << self
+      def from_file(filename)
+        loader = loader_for(::File.extname(filename))
+
+        unless loader
+          message = "This file format is not supported."
+          raise ::RemoveDataAttributes::InvalidConfiguration, message
+        end
+
+        ::File.open(filename) { |file| new(loader.load(file)) }
+      end
 
-    def configure
-      yield(configuration) if block_given?
+      def supported_file_extensions
+        @supported_file_extensions ||= SUPPORTED_FILE_FORMATS.values.flatten.sort
+      end
+
+      private
+
+      # :reek:ControlParameter
+      def loader_for(extname)
+        case extname
+        when *SUPPORTED_FILE_FORMATS["YAML"] then ::YAML
+        end
+      end
     end
-  end
 
-  class Configuration
-    attr_writer :data_attributes
+    # :reek:ManualDispatch
+    def initialize(attributes = {})
+      attributes.each do |attribute_name, value|
+        method_name = "#{attribute_name}="
+        public_send(method_name, value) if respond_to?(method_name)
+      end
+    end
 
     def data_attributes
       @data_attributes ||= []

data/lib/remove_data_attributes/errors.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module RemoveDataAttributes
+  class Error < ::StandardError
+  end
+
+  class ConfigurationNotFound < ::RemoveDataAttributes::Error
+    def initialize(dirname)
+      super("No configuration file is found in #{dirname}.")
+    end
+  end
+
+  class InvalidConfiguration < ::RemoveDataAttributes::Error
+  end
+end

data/lib/remove_data_attributes/railtie.rb

@@ -8,18 +8,29 @@ require "remove_data_attributes/tag_options_filter"
 
 module RemoveDataAttributes
   class Railtie < ::Rails::Railtie
-    config.after_initialize do
+    initializer "remove_data_attributes" do
+      configuration = ::RemoveDataAttributes::Configuration.from_file(find_configuration_file)
+      next if configuration.data_attributes.empty?
+
       ::ActiveSupport.on_load(:action_view) do
-        patch = ::RemoveDataAttributes::TagOptionsFilter[
-          ::RemoveDataAttributes.configuration.data_attributes
-        ]
+        patch = ::RemoveDataAttributes::TagOptionsFilter[configuration.data_attributes]
 
-        if Gem::Version.new(Rails.version) < Gem::Version.new("5.1")
+        if ::Gem::Version.new(::Rails.version) < ::Gem::Version.new("5.1")
           ::ActionView::Helpers::TagHelper.include(patch)
         else
           ::ActionView::Helpers::TagHelper::TagBuilder.include(patch)
         end
       end
     end
+
+    private
+
+    def find_configuration_file
+      root = ::Rails.root.join("config")
+      extensions = ::RemoveDataAttributes::Configuration.supported_file_extensions
+
+      ::Dir.glob(root.join("remove_data_attributes{#{extensions.join(',')}}")).first ||
+        raise(::RemoveDataAttributes::ConfigurationNotFound, root)
+    end
   end
 end

data/lib/remove_data_attributes/tag_options_filter.rb

@@ -25,7 +25,7 @@ module RemoveDataAttributes
           extend ::ActiveSupport::Concern
 
           included do |klass|
-            patch = Module.new do
+            patch = ::Module.new do
               define_method(method_name) do |options, escape = true|
                 options.is_a?(::Hash) ?
                   super(processor.call(options), escape) : super(options, escape)

data/lib/remove_data_attributes/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RemoveDataAttributes
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: remove_data_attributes
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - yasaichi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-10 00:00:00.000000000 Z
+date: 2017-12-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rails
+  name: railties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.0
+- !ruby/object:Gem::Dependency
+  name: ammeter
+  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: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -106,13 +120,16 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- lib/generators/remove_data_attributes/install/USAGE
+- lib/generators/remove_data_attributes/install/install_generator.rb
+- lib/generators/remove_data_attributes/install/templates/remove_data_attributes.yml
 - lib/remove_data_attributes.rb
 - lib/remove_data_attributes/configuration.rb
+- lib/remove_data_attributes/errors.rb
 - lib/remove_data_attributes/processor.rb
 - lib/remove_data_attributes/railtie.rb
 - lib/remove_data_attributes/tag_options_filter.rb
 - lib/remove_data_attributes/version.rb
-- lib/tasks/remove_data_attributes_tasks.rake
 homepage: https://github.com/yasaichi/remove_data_attributes
 licenses:
 - MIT

data/lib/tasks/remove_data_attributes_tasks.rake

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-# desc "Explaining what the task does"
-# task :remove_data_attributes do
-#   # Task goes here
-# end