view_component 1.16.0
Sign up to get free protection for your applications and to get access to all the features.
Potentially problematic release.
This version of view_component might be problematic. Click here for more details.
- checksums.yaml +7 -0
- data/.github/ISSUE_TEMPLATE +27 -0
- data/.github/PULL_REQUEST_TEMPLATE +17 -0
- data/.github/workflows/ruby_on_rails.yml +31 -0
- data/.gitignore +53 -0
- data/.rubocop.yml +8 -0
- data/CHANGELOG.md +373 -0
- data/CODE_OF_CONDUCT.md +76 -0
- data/CONTRIBUTING.md +46 -0
- data/Gemfile +8 -0
- data/Gemfile.lock +202 -0
- data/LICENSE.txt +21 -0
- data/README.md +460 -0
- data/Rakefile +12 -0
- data/app/controllers/rails/components_controller.rb +65 -0
- data/docs/case-studies/jellyswitch.md +76 -0
- data/lib/action_view/component.rb +4 -0
- data/lib/action_view/component/base.rb +13 -0
- data/lib/action_view/component/preview.rb +8 -0
- data/lib/action_view/component/railtie.rb +3 -0
- data/lib/action_view/component/test_case.rb +9 -0
- data/lib/action_view/component/test_helpers.rb +17 -0
- data/lib/rails/generators/component/USAGE +13 -0
- data/lib/rails/generators/component/component_generator.rb +44 -0
- data/lib/rails/generators/component/templates/component.rb.tt +5 -0
- data/lib/rails/generators/erb/component_generator.rb +21 -0
- data/lib/rails/generators/erb/templates/component.html.erb.tt +1 -0
- data/lib/rails/generators/haml/component_generator.rb +21 -0
- data/lib/rails/generators/haml/templates/component.html.haml.tt +1 -0
- data/lib/rails/generators/rspec/component_generator.rb +19 -0
- data/lib/rails/generators/rspec/templates/component_spec.rb.tt +13 -0
- data/lib/rails/generators/slim/component_generator.rb +21 -0
- data/lib/rails/generators/slim/templates/component.html.slim.tt +1 -0
- data/lib/rails/generators/test_unit/component_generator.rb +20 -0
- data/lib/rails/generators/test_unit/templates/component_test.rb.tt +10 -0
- data/lib/railties/lib/rails.rb +5 -0
- data/lib/railties/lib/rails/templates/rails/components/index.html.erb +8 -0
- data/lib/railties/lib/rails/templates/rails/components/preview.html.erb +1 -0
- data/lib/railties/lib/rails/templates/rails/components/previews.html.erb +6 -0
- data/lib/view_component.rb +30 -0
- data/lib/view_component/base.rb +279 -0
- data/lib/view_component/conversion.rb +9 -0
- data/lib/view_component/engine.rb +65 -0
- data/lib/view_component/preview.rb +78 -0
- data/lib/view_component/previewable.rb +25 -0
- data/lib/view_component/render_monkey_patch.rb +31 -0
- data/lib/view_component/rendering_monkey_patch.rb +13 -0
- data/lib/view_component/template_error.rb +9 -0
- data/lib/view_component/test_case.rb +9 -0
- data/lib/view_component/test_helpers.rb +39 -0
- data/lib/view_component/version.rb +11 -0
- data/script/bootstrap +6 -0
- data/script/console +8 -0
- data/script/install +6 -0
- data/script/release +6 -0
- data/script/test +6 -0
- data/view_component.gemspec +46 -0
- metadata +226 -0
@@ -0,0 +1,25 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "active_support/concern"
|
4
|
+
|
5
|
+
module ViewComponent # :nodoc:
|
6
|
+
module Previewable
|
7
|
+
extend ActiveSupport::Concern
|
8
|
+
|
9
|
+
included do
|
10
|
+
# Set the location of component previews through app configuration:
|
11
|
+
#
|
12
|
+
# config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
|
13
|
+
#
|
14
|
+
mattr_accessor :preview_path, instance_writer: false
|
15
|
+
|
16
|
+
# Enable or disable component previews through app configuration:
|
17
|
+
#
|
18
|
+
# config.action_view_component.show_previews = true
|
19
|
+
#
|
20
|
+
# Defaults to +true+ for development environment
|
21
|
+
#
|
22
|
+
mattr_accessor :show_previews, instance_writer: false
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module ViewComponent
|
4
|
+
module RenderMonkeyPatch # :nodoc:
|
5
|
+
def render(options = {}, args = {}, &block)
|
6
|
+
if options.respond_to?(:render_in) && Rails.version.to_f < 6.1
|
7
|
+
options.render_in(self, &block)
|
8
|
+
elsif options.is_a?(Class) && options < ActionView::Component::Base
|
9
|
+
ActiveSupport::Deprecation.warn(
|
10
|
+
"`render MyComponent, foo: :bar` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
|
11
|
+
)
|
12
|
+
|
13
|
+
options.new(args).render_in(self, &block)
|
14
|
+
elsif options.is_a?(Hash) && options.has_key?(:component) && options[:component] < ActionView::Component::Base
|
15
|
+
ActiveSupport::Deprecation.warn(
|
16
|
+
"`render component: MyComponent, locals: { foo: :bar }` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
|
17
|
+
)
|
18
|
+
|
19
|
+
options[:component].new(options[:locals]).render_in(self, &block)
|
20
|
+
elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil? && options.to_component_class < ActionView::Component::Base
|
21
|
+
ActiveSupport::Deprecation.warn(
|
22
|
+
"rendering objects that respond_to `to_component_class` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
|
23
|
+
)
|
24
|
+
|
25
|
+
options.to_component_class.new(options).render_in(self, &block)
|
26
|
+
else
|
27
|
+
super
|
28
|
+
end
|
29
|
+
end
|
30
|
+
end
|
31
|
+
end
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
module ViewComponent
|
4
|
+
module RenderingMonkeyPatch # :nodoc:
|
5
|
+
def render(options = {}, args = {})
|
6
|
+
if options.respond_to?(:render_in) && Rails.version.to_f < 6.1
|
7
|
+
self.response_body = options.render_in(self.view_context)
|
8
|
+
else
|
9
|
+
super
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
@@ -0,0 +1,39 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
require "capybara/minitest"
|
4
|
+
|
5
|
+
module ViewComponent
|
6
|
+
module TestHelpers
|
7
|
+
include Capybara::Minitest::Assertions
|
8
|
+
|
9
|
+
def page
|
10
|
+
Capybara::Node::Simple.new(@raw)
|
11
|
+
end
|
12
|
+
|
13
|
+
def refute_component_rendered
|
14
|
+
assert_no_selector("body")
|
15
|
+
end
|
16
|
+
|
17
|
+
def render_inline(component, **args, &block)
|
18
|
+
@raw = controller.view_context.render(component, args, &block)
|
19
|
+
|
20
|
+
Nokogiri::HTML.fragment(@raw)
|
21
|
+
end
|
22
|
+
|
23
|
+
def controller
|
24
|
+
@controller ||= Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
|
25
|
+
end
|
26
|
+
|
27
|
+
def request
|
28
|
+
@request ||= ActionDispatch::TestRequest.create
|
29
|
+
end
|
30
|
+
|
31
|
+
def with_variant(variant)
|
32
|
+
old_variants = controller.view_context.lookup_context.variants
|
33
|
+
|
34
|
+
controller.view_context.lookup_context.variants = variant
|
35
|
+
yield
|
36
|
+
controller.view_context.lookup_context.variants = old_variants
|
37
|
+
end
|
38
|
+
end
|
39
|
+
end
|
data/script/bootstrap
ADDED
data/script/console
ADDED
data/script/install
ADDED
data/script/release
ADDED
data/script/test
ADDED
@@ -0,0 +1,46 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
# frozen_string_literal: true
|
3
|
+
|
4
|
+
lib = File.expand_path("../lib", __FILE__)
|
5
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
6
|
+
require "view_component/version"
|
7
|
+
|
8
|
+
Gem::Specification.new do |spec|
|
9
|
+
spec.name = "view_component"
|
10
|
+
spec.version = ViewComponent::VERSION::STRING
|
11
|
+
spec.authors = ["GitHub Open Source"]
|
12
|
+
spec.email = ["opensource+view_component@github.com"]
|
13
|
+
|
14
|
+
spec.summary = %q{View components for Rails}
|
15
|
+
spec.description = %q{View components for Rails}
|
16
|
+
spec.homepage = "https://github.com/github/view_component"
|
17
|
+
spec.license = "MIT"
|
18
|
+
|
19
|
+
# Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
|
20
|
+
# to allow pushing to a single host or delete this section to allow pushing to any host.
|
21
|
+
if spec.respond_to?(:metadata)
|
22
|
+
spec.metadata["allowed_push_host"] = "https://rubygems.org"
|
23
|
+
else
|
24
|
+
raise "RubyGems 2.0 or newer is required to protect against " \
|
25
|
+
"public gem pushes."
|
26
|
+
end
|
27
|
+
|
28
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
29
|
+
f.match(%r{^(test|spec|features)/})
|
30
|
+
end
|
31
|
+
spec.bindir = "exe"
|
32
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
33
|
+
spec.require_paths = ["lib"]
|
34
|
+
|
35
|
+
spec.required_ruby_version = ">= 2.3.0"
|
36
|
+
|
37
|
+
spec.add_runtime_dependency "capybara", ">= 3"
|
38
|
+
spec.add_development_dependency "bundler", ">= 1.14"
|
39
|
+
spec.add_development_dependency "rake", "~> 13.0"
|
40
|
+
spec.add_development_dependency "minitest", "= 5.1.0"
|
41
|
+
spec.add_development_dependency "haml", "~> 5"
|
42
|
+
spec.add_development_dependency "slim", "~> 4.0"
|
43
|
+
spec.add_development_dependency "better_html", "~> 1"
|
44
|
+
spec.add_development_dependency "rubocop", "= 0.74"
|
45
|
+
spec.add_development_dependency "rubocop-github", "~> 0.13.0"
|
46
|
+
end
|
metadata
ADDED
@@ -0,0 +1,226 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: view_component
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 1.16.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- GitHub Open Source
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2020-03-20 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: capybara
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '3'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '3'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.14'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.14'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '13.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '13.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: minitest
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - '='
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: 5.1.0
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - '='
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: 5.1.0
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: haml
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '5'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '5'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: slim
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '4.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '4.0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: better_html
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '1'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '1'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: rubocop
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - '='
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0.74'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - '='
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0.74'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: rubocop-github
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: 0.13.0
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: 0.13.0
|
139
|
+
description: View components for Rails
|
140
|
+
email:
|
141
|
+
- opensource+view_component@github.com
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".github/ISSUE_TEMPLATE"
|
147
|
+
- ".github/PULL_REQUEST_TEMPLATE"
|
148
|
+
- ".github/workflows/ruby_on_rails.yml"
|
149
|
+
- ".gitignore"
|
150
|
+
- ".rubocop.yml"
|
151
|
+
- CHANGELOG.md
|
152
|
+
- CODE_OF_CONDUCT.md
|
153
|
+
- CONTRIBUTING.md
|
154
|
+
- Gemfile
|
155
|
+
- Gemfile.lock
|
156
|
+
- LICENSE.txt
|
157
|
+
- README.md
|
158
|
+
- Rakefile
|
159
|
+
- app/controllers/rails/components_controller.rb
|
160
|
+
- docs/case-studies/jellyswitch.md
|
161
|
+
- lib/action_view/component.rb
|
162
|
+
- lib/action_view/component/base.rb
|
163
|
+
- lib/action_view/component/preview.rb
|
164
|
+
- lib/action_view/component/railtie.rb
|
165
|
+
- lib/action_view/component/test_case.rb
|
166
|
+
- lib/action_view/component/test_helpers.rb
|
167
|
+
- lib/rails/generators/component/USAGE
|
168
|
+
- lib/rails/generators/component/component_generator.rb
|
169
|
+
- lib/rails/generators/component/templates/component.rb.tt
|
170
|
+
- lib/rails/generators/erb/component_generator.rb
|
171
|
+
- lib/rails/generators/erb/templates/component.html.erb.tt
|
172
|
+
- lib/rails/generators/haml/component_generator.rb
|
173
|
+
- lib/rails/generators/haml/templates/component.html.haml.tt
|
174
|
+
- lib/rails/generators/rspec/component_generator.rb
|
175
|
+
- lib/rails/generators/rspec/templates/component_spec.rb.tt
|
176
|
+
- lib/rails/generators/slim/component_generator.rb
|
177
|
+
- lib/rails/generators/slim/templates/component.html.slim.tt
|
178
|
+
- lib/rails/generators/test_unit/component_generator.rb
|
179
|
+
- lib/rails/generators/test_unit/templates/component_test.rb.tt
|
180
|
+
- lib/railties/lib/rails.rb
|
181
|
+
- lib/railties/lib/rails/templates/rails/components/index.html.erb
|
182
|
+
- lib/railties/lib/rails/templates/rails/components/preview.html.erb
|
183
|
+
- lib/railties/lib/rails/templates/rails/components/previews.html.erb
|
184
|
+
- lib/view_component.rb
|
185
|
+
- lib/view_component/base.rb
|
186
|
+
- lib/view_component/conversion.rb
|
187
|
+
- lib/view_component/engine.rb
|
188
|
+
- lib/view_component/preview.rb
|
189
|
+
- lib/view_component/previewable.rb
|
190
|
+
- lib/view_component/render_monkey_patch.rb
|
191
|
+
- lib/view_component/rendering_monkey_patch.rb
|
192
|
+
- lib/view_component/template_error.rb
|
193
|
+
- lib/view_component/test_case.rb
|
194
|
+
- lib/view_component/test_helpers.rb
|
195
|
+
- lib/view_component/version.rb
|
196
|
+
- script/bootstrap
|
197
|
+
- script/console
|
198
|
+
- script/install
|
199
|
+
- script/release
|
200
|
+
- script/test
|
201
|
+
- view_component.gemspec
|
202
|
+
homepage: https://github.com/github/view_component
|
203
|
+
licenses:
|
204
|
+
- MIT
|
205
|
+
metadata:
|
206
|
+
allowed_push_host: https://rubygems.org
|
207
|
+
post_install_message:
|
208
|
+
rdoc_options: []
|
209
|
+
require_paths:
|
210
|
+
- lib
|
211
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
212
|
+
requirements:
|
213
|
+
- - ">="
|
214
|
+
- !ruby/object:Gem::Version
|
215
|
+
version: 2.3.0
|
216
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
217
|
+
requirements:
|
218
|
+
- - ">="
|
219
|
+
- !ruby/object:Gem::Version
|
220
|
+
version: '0'
|
221
|
+
requirements: []
|
222
|
+
rubygems_version: 3.0.3
|
223
|
+
signing_key:
|
224
|
+
specification_version: 4
|
225
|
+
summary: View components for Rails
|
226
|
+
test_files: []
|