view_component 2.1.0 → 2.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f6cbdc740d6c9175742269ff9b13a759e28b188d2abcdda03d85bafff44ac7a
-  data.tar.gz: a00eff317e112a844e65fb196e6a2e7832e0ff7b5ede73ba47196131d92f9d65
+  metadata.gz: '038805cb5a61ac698697344495e23064c227e169079586e1412f43aee0a7abde'
+  data.tar.gz: bb53f4c2407eec96e618aba01f4f35cfa564bfc8738c709af434c16a412457d8
 SHA512:
-  metadata.gz: 68ac701e9c6814d9f6384e393b0ac9ac18a2646b85bef1e972a092bd252f7e573c4c5c6aea73056d75a6597d71076fb43e40ba6edd4eb1a73c88618881fc9705
-  data.tar.gz: '099f69cfb27e52b9e337328c204fc512e1c151b562a22e94783a58ed99952856994575a9b5556f4a0ebf5c7b54012bfab55330956fc67478f19057784090894e'
+  metadata.gz: 7adf9a57806404434ad35b23d4df069dfe2a346cb35945e9103b16197e0f86c2b994d1470334c324ee38365781f5be5742a1e42369309a5d29a15f5f3e8b01c8
+  data.tar.gz: ce7cb220863df4567a97f472fa576fdd96b045aa7ef507c456c69616270195448204a0a6cf01889d177b7430a7fc4f59486af74ad85463927e20427bde3ad996

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # master
 
+# v2.2.0
+
+* Add support for `config.action_view.annotate_template_file_names` (coming in Rails 6.1).
+
+    *Joel Hawksley*
+
+* Remove initializer requirement from the component.
+
+    *Vasiliy Ermolovich*
+
 # v2.1.0
 
 * Support rendering collections (e.g., `render(MyComponent.with_collection(@items))`).

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    view_component (2.1.0)
+    view_component (2.2.0)
       capybara (~> 3)
 
 GEM
@@ -74,7 +74,7 @@ GEM
       parser (>= 2.4)
       smart_properties
     builder (3.2.4)
-    capybara (3.31.0)
+    capybara (3.32.0)
       addressable
       mini_mime (>= 0.1.3)
       nokogiri (~> 1.8)

data/README.md

@@ -152,8 +152,6 @@ Which returns:
 <span title="my title">Hello, World!</span>
 ```
 
-`ViewComponent` requires the presence of an `initialize` method in each component.
-
 #### Content Areas
 
 A component can declare additional content areas to be rendered in the component. For example:
@@ -162,9 +160,6 @@ A component can declare additional content areas to be rendered in the component
 ```ruby
 class ModalComponent < ViewComponent::Base
   with_content_areas :header, :body
-
-  def initialize(*)
-  end
 end
 ```
 
@@ -498,10 +493,10 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/github
 |@mellowfish|@horacio|@dukex|@dark-panda|@smashwilson|
 |Spring Hill, TN|Buenos Aires|São Paulo||Gambrills, MD|
 
-|<img src="https://avatars.githubusercontent.com/blakewilliams?s=256" alt="blakewilliams" width="128" />|<img src="https://avatars.githubusercontent.com/seanpdoyle?s=256" alt="seanpdoyle" width="128" />|<img src="https://avatars.githubusercontent.com/tclem?s=256" alt="tclem" width="128" />|
-|:---:|:---:|:---:|
-|@blakewilliams|@seanpdoyle|@tclem|
-|Boston, MA|New York, NY|San Francisco, CA|
+|<img src="https://avatars.githubusercontent.com/blakewilliams?s=256" alt="blakewilliams" width="128" />|<img src="https://avatars.githubusercontent.com/seanpdoyle?s=256" alt="seanpdoyle" width="128" />|<img src="https://avatars.githubusercontent.com/tclem?s=256" alt="tclem" width="128" />|<img src="https://avatars.githubusercontent.com/nashby?s=256" alt="nashby" width="128" />
+|:---:|:---:|:---:|:---:|
+|@blakewilliams|@seanpdoyle|@tclem|@nashby|
+|Boston, MA|New York, NY|San Francisco, CA|Minsk|
 
 ## License
 

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

@@ -29,11 +29,9 @@ module Rails
       end
 
       def initialize_signature
-        if attributes.present?
-          attributes.map { |attr| "#{attr.name}:" }.join(", ")
-        else
-          "*"
-        end
+        return if attributes.blank?
+
+        attributes.map { |attr| "#{attr.name}:" }.join(", ")
       end
 
       def initialize_body

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

@@ -1,5 +1,7 @@
 class <%= class_name %>Component < <%= parent_class %>
+<%- if initialize_signature -%>
   def initialize(<%= initialize_signature %>)
     <%= initialize_body %>
   end
+<%- end -%>
 end

data/lib/view_component/base.rb

@@ -77,6 +77,10 @@ module ViewComponent
       true
     end
 
+    def self.short_identifier
+      @short_identifier ||= defined?(Rails.root) ? source_location.sub("#{Rails.root}/", "") : source_location
+    end
+
     def initialize(*); end
 
     def render(options = {}, args = {}, &block)
@@ -137,11 +141,15 @@ module ViewComponent
     @@test_controller = "ApplicationController"
 
     class << self
+      attr_accessor :source_location
+
       def inherited(child)
         if defined?(Rails)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
         end
 
+        child.source_location = caller_locations(1, 1)[0].absolute_path
+
         super
       end
 
@@ -153,16 +161,6 @@ module ViewComponent
         end
       end
 
-      def source_location
-        @source_location ||=
-          begin
-            # Require `#initialize` to be defined so that we can use `method#source_location`
-            # to look up the filename of the component.
-            initialize_method = instance_method(:initialize)
-            initialize_method.source_location[0] if initialize_method.owner == self
-          end
-      end
-
       def compiled?
         @compiled && ActionView::Base.cache_template_loading
       end
@@ -186,8 +184,20 @@ module ViewComponent
           return false
         end
 
+        # If template name annotations are turned on, a line is dynamically
+        # added with a comment. In this case, we want to return a different
+        # starting line number so errors that are raised will point to the
+        # correct line in the component template.
+        line_number =
+          if ActionView::Base.respond_to?(:annotate_template_file_names) &&
+            ActionView::Base.annotate_template_file_names
+            -2
+          else
+            -1
+          end
+
         templates.each do |template|
-          class_eval <<-RUBY, template[:path], -1
+          class_eval <<-RUBY, template[:path], line_number
             def #{call_method_name(template[:variant])}
               @output_buffer = ActionView::OutputBuffer.new
               #{compiled_template(template[:path])}
@@ -252,12 +262,6 @@ module ViewComponent
         @template_errors ||=
           begin
             errors = []
-            if source_location.nil?
-              # Require `#initialize` to be defined so that we can use `method#source_location`
-              # to look up the filename of the component.
-              errors << "#{self} must implement #initialize."
-            end
-
             errors << "Could not find a template file for #{self}." if templates.empty?
 
             if templates.count { |template| template[:variant].nil? } > 1
@@ -283,7 +287,7 @@ module ViewComponent
 
         if handler.method(:call).parameters.length > 1
           handler.call(self, template)
-        else # remove before upstreaming into Rails
+        else
           handler.call(OpenStruct.new(source: template, identifier: identifier, type: type))
         end
       end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 1
+    MINOR = 2
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-27 00:00:00.000000000 Z
+date: 2020-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara