view_component-no_component 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1f2a5bcc5387ccc40d75f1b18cda4a97f2a50e290ec3c6f22e76675be1ba023a
+  data.tar.gz: 95c0f455ba0e8213418193f32f7518816cc1b8386c52aafeea2642c78ba66da2
+SHA512:
+  metadata.gz: '008a4485aff913f096855792a0c33438ca6181102b746efbe960f7020aaf0a2d119a8f098183ae93746844ed86154cd54b0fbbfb068806a1ce148c3091a68cf2'
+  data.tar.gz: 4add5b61b3894e9b0321ba61ec7f340fa5e1afb921994ce4841db2c8029adeb5b98a2b433702c6a62c0023d35c037a4f307e5c0425df8f032cb75771eca26734

data/.github/workflows/gem-push.yml

@@ -0,0 +1,42 @@
+name: Ruby Gem
+
+on:
+  push:
+    branches: [ main ]
+    paths:
+      - 'view_component-no_component.gemspec'
+
+jobs:
+  build:
+    name: Build + Publish
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby 2.7
+      uses: actions/setup-ruby@v1
+      with:
+        ruby-version: 2.7.x
+
+    - name: Publish to GPR
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:github: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
+      env:
+        GEM_HOST_API_KEY: "Bearer ${{secrets.GITHUB_TOKEN}}"
+        OWNER: ${{ github.repository_owner }}
+
+    - name: Publish to RubyGems
+      run: |
+        mkdir -p $HOME/.gem
+        touch $HOME/.gem/credentials
+        chmod 0600 $HOME/.gem/credentials
+        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
+        gem build *.gemspec
+        gem push *.gem
+      env:
+        GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

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

data/.rspec

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

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 si@mon.fish. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in view_component-no_component.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Simon Fish
+
+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,41 @@
+# ViewComponent::NoComponent
+
+Updates the `view_component` generators to remove the `Component` suffix.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'view_component-no_component'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install view_component-no_component
+
+## Usage
+
+Use the generators as directed by the `view_component` docs.
+
+## 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/si/view_component-no_component. 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/si/view_component-no_component/blob/master/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 ViewComponent::NoComponent project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/si/view_component-no_component/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "view_component/no_component"
+
+# 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/rails/generators/component/USAGE

@@ -0,0 +1,13 @@
+Description:
+============
+    Creates a new component and test.
+    Pass the component name, either CamelCased or under_scored, and an optional list of attributes as arguments.
+
+Example:
+========
+    bin/rails generate component Profile name age
+
+    creates a Profile component and test:
+        Component:    app/components/profile.rb
+        Template:     app/components/profile.html.erb
+        Test:         test/components/profile.rb

data/lib/rails/generators/component/component_generator.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class ComponentGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      check_class_collision
+      class_option :inline, type: :boolean, default: false
+
+      def create_component_file
+        template "component.rb", File.join("app/components", class_path, "#{file_name}.rb")
+      end
+
+      hook_for :test_framework
+
+      hook_for :preview, type: :boolean
+
+      hook_for :template_engine do |instance, template_engine|
+        instance.invoke template_engine, [instance.name]
+      end
+
+      private
+
+      def parent_class
+        defined?(ApplicationComponent) ? "ApplicationComponent" : "ViewComponent::Base"
+      end
+
+      def initialize_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| "#{attr.name}:" }.join(", ")
+      end
+
+      def initialize_body
+        attributes.map { |attr| "@#{attr.name} = #{attr.name}" }.join("\n    ")
+      end
+
+      def initialize_call_method_for_inline?
+        options["inline"]
+      end
+    end
+  end
+end

data/lib/rails/generators/component/templates/component.rb.tt

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+class <%= class_name %> < <%= parent_class %>
+<%- if initialize_signature -%>
+  def initialize(<%= initialize_signature %>)
+    <%= initialize_body %>
+  end
+<%- end -%>
+<%- if initialize_call_method_for_inline? -%>
+  def call
+    content_tag :h1, "Hello world!"
+  end
+<%- end -%>
+
+end

data/lib/rails/generators/erb/component_generator.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb"
+
+module Erb
+  module Generators
+    class ComponentGenerator < Base
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+      class_option :inline, type: :boolean, default: false
+
+      def copy_view_file
+        unless options["inline"]
+          template "component.html.erb", destination
+        end
+      end
+
+      private
+
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}", "#{file_name}.html.erb")
+        else
+          File.join("app/components", class_path, "#{file_name}.html.erb")
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/erb/templates/component.html.erb.tt

@@ -0,0 +1 @@
+<div>Add <%= class_name %> template here</div>

data/lib/rails/generators/haml/component_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Haml
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+
+      def copy_view_file
+        if !options["inline"]
+          template "component.html.haml", destination
+        end
+      end
+
+      private
+
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}", "#{file_name}.html.haml")
+        else
+          File.join("app/components", class_path, "#{file_name}.html.haml")
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/haml/templates/component.html.haml.tt

@@ -0,0 +1 @@
+%div Add <%= class_name %> template here

data/lib/rails/generators/preview/component_generator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Preview
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      check_class_collision suffix: "Preview"
+
+      def create_preview_file
+        preview_paths = Rails.application.config.view_component.preview_paths
+        return if preview_paths.count > 1
+
+        path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"
+        template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_preview.rb")
+      end
+    end
+  end
+end

data/lib/rails/generators/preview/templates/component_preview.rb.tt

@@ -0,0 +1,5 @@
+class <%= class_name %>Preview < ViewComponent::Preview
+  def default
+    render(<%= class_name %>.new)
+  end
+end

data/lib/rails/generators/rspec/component_generator.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template "component_spec.rb", File.join("spec/components", class_path, "#{file_name}_spec.rb")
+      end
+    end
+  end
+end

data/lib/rails/generators/rspec/templates/component_spec.rb.tt

@@ -0,0 +1,13 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %>, type: :component do
+  pending "add some examples to (or delete) #{__FILE__}"
+
+  # it "renders something useful" do
+  #   expect(
+  #     render_inline(described_class.new(attr: "value")) { "Hello, components!" }.css("p").to_html
+  #   ).to include(
+  #     "Hello, components!"
+  #   )
+  # end
+end

data/lib/rails/generators/slim/component_generator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Slim
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+      class_option :sidecar, type: :boolean, default: false
+
+      def copy_view_file
+        if !options["inline"]
+          template "component.html.slim", destination
+        end
+      end
+
+      private
+
+      def destination
+        if options["sidecar"]
+          File.join("app/components", class_path, "#{file_name}", "#{file_name}.html.slim")
+        else
+          File.join("app/components", class_path, "#{file_name}.html.slim")
+        end
+      end
+    end
+  end
+end

data/lib/rails/generators/slim/templates/component.html.slim.tt

@@ -0,0 +1 @@
+div Add <%= class_name %> template here

data/lib/rails/generators/test_unit/component_generator.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module TestUnit
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "Test"
+
+      def create_test_file
+        template "component_test.rb", File.join("test/components", class_path, "#{file_name}_test.rb")
+      end
+    end
+  end
+end

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -0,0 +1,10 @@
+require "test_helper"
+
+class <%= class_name %>Test < ViewComponent::TestCase
+  def test_component_renders_something_useful
+    # assert_equal(
+    #   %(<span>Hello, components!</span>),
+    #   render_inline(<%= class_name %>.new(message: "Hello, components!")).css("span").to_html
+    # )
+  end
+end

data/view_component-no_component.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |spec|
+  spec.name          = "view_component-no_component"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Simon Fish"]
+  spec.email         = ["si@mon.fish"]
+
+  spec.summary       = %q{Updates the view_component generators to remove the Component suffix.}
+  spec.description   = %q{Updates the view_component generators to remove the Component suffix.}
+  spec.homepage      = "https://github.com/boardfish/view_component-no_component"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/boardfish/view_component-no_component"
+
+  # 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('..', __FILE__)) 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"]
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: view_component-no_component
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Simon Fish
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-04-19 00:00:00.000000000 Z
+dependencies: []
+description: Updates the view_component generators to remove the Component suffix.
+email:
+- si@mon.fish
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/gem-push.yml"
+- ".gitignore"
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/rails/generators/component/USAGE
+- lib/rails/generators/component/component_generator.rb
+- lib/rails/generators/component/templates/component.rb.tt
+- lib/rails/generators/erb/component_generator.rb
+- lib/rails/generators/erb/templates/component.html.erb.tt
+- lib/rails/generators/haml/component_generator.rb
+- lib/rails/generators/haml/templates/component.html.haml.tt
+- lib/rails/generators/preview/component_generator.rb
+- lib/rails/generators/preview/templates/component_preview.rb.tt
+- lib/rails/generators/rspec/component_generator.rb
+- lib/rails/generators/rspec/templates/component_spec.rb.tt
+- lib/rails/generators/slim/component_generator.rb
+- lib/rails/generators/slim/templates/component.html.slim.tt
+- lib/rails/generators/test_unit/component_generator.rb
+- lib/rails/generators/test_unit/templates/component_test.rb.tt
+- view_component-no_component.gemspec
+homepage: https://github.com/boardfish/view_component-no_component
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/boardfish/view_component-no_component
+  source_code_uri: https://github.com/boardfish/view_component-no_component
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: Updates the view_component generators to remove the Component suffix.
+test_files: []