view_spec 0.0.0 → 0.0.1

data/lib/view_spec/note.rb

@@ -0,0 +1,44 @@
+module ViewSpec
+  class Note
+    delegate :lang, to: :@executable
+
+    def initialize(entry, executable)
+      @entry = entry
+      @executable = executable
+    end
+
+    def call(view_context = nil)
+      @rendered ||= begin
+        text = renderer(view_context).render(renderable, assigns:, layout: false)
+        output = (lang == :md) ? markdown.render(text) : text
+        output.html_safe
+      end
+    end
+
+    def render_in(view_context)
+      call(view_context)
+    end
+
+    alias_method :to_s, :call
+    alias_method :to_str, :call
+
+    private
+
+    def renderer(view_context = nil)
+      view_context || @entry.controller
+    end
+
+    def renderable
+      executable = @executable.is_a?(ExecutableString) ? ExecutableString.new(@executable.raw, :erb) : @executable
+      @renderable ||= Renderable.new(@entry.short_identifier, executable)
+    end
+
+    def markdown
+      @markdown || Markdown.new
+    end
+
+    def assigns
+      {params: @entry.resolve_params}
+    end
+  end
+end

data/lib/view_spec/param.rb

@@ -3,9 +3,11 @@ module ViewSpec
   class Param
     include ::ActionView::Helpers::SanitizeHelper
 
+    NO_DEFAULT = Object.new
+
     attr_reader :name, :options
 
-    def initialize(name, cast_type = nil, value: nil, default: nil, **type_options)
+    def initialize(name, cast_type = nil, value: nil, default: NO_DEFAULT, **type_options)
       @name = name.to_sym
       @cast_type = cast_type
       @value = value
@@ -21,6 +23,14 @@ module ViewSpec
       @type ||= Type.for(@cast_type, **@type_options)
     end
 
+    def default
+      (@default == NO_DEFAULT) ? nil : @default
+    end
+
+    def default?
+      @default != NO_DEFAULT
+    end
+
     def to_pair
       [name, value]
     end
@@ -28,7 +38,7 @@ module ViewSpec
     private
 
     def raw_value
-      sanitize(@value) || @default
+      sanitize(@value) || default
     end
   end
 end

data/lib/view_spec/param_set.rb

@@ -2,31 +2,37 @@ module ViewSpec
   class ParamSet
     include Enumerable
 
-    delegate :each, to: :@params
+    delegate :key?, :keys, :each, to: :@params
 
     def initialize
-      @params = []
+      @params = ActiveSupport::OrderedOptions.new.merge!({})
     end
 
     def add(name, cast_type = nil, value: nil, **options)
       if name.is_a?(Hash)
-        @params += name.map { Param.new(_1, value: _2) }
+        name.each { add(_1, value: _2) }
       else
-        @params << Param.new(name, cast_type, value:, **options)
+        @params[name.to_sym] = Param.new(name, cast_type, value:, **options)
       end
-      @params.uniq!(&:name)
+      @params
     end
 
-    def names
-      @params.map(&:name)
+    def to_h
+      @params.transform_values { _1.value }
     end
 
-    def include?(name)
-      names.include?(name)
+    alias_method :to_hash, :to_h
+
+    def respond_to_missing?(name, include_private = false)
+      @params.key?(name)
     end
 
-    def to_h
-      @params.map { _1.to_pair }.to_h
+    def method_missing(name, ...)
+      if @params.key?(name)
+        @params.fetch(name).value
+      else
+        super
+      end
     end
   end
 end

data/lib/view_spec/preview.rb

@@ -0,0 +1,44 @@
+module ViewSpec
+  class Preview
+    def initialize(entry, params: {}, assigns: {}, layout: false, identifier: nil)
+      @entry = entry
+      @params = params
+      @assigns = assigns
+      @layout = layout
+    end
+
+    def to_path(params: @params.to_h)
+      url_helpers.view_spec_preview_path(@entry.spec, @entry, {params:})
+    end
+
+    def to_url(params: @params.to_h)
+      url_helpers.view_spec_preview_url(@entry.spec, @entry, {params:})
+    end
+
+    def render_in(view_context)
+      call(view_context)
+    end
+
+    def call(view_context = nil)
+      raise "ViewSpec::Preview subclasses must implement the `call` method"
+    end
+
+    def params(validate: false)
+      @entry.resolve_params(@params)
+    end
+
+    def layout
+      @entry.determine_layout(@layout)
+    end
+
+    private
+
+    def renderer(view_context = nil)
+      view_context || @entry.controller
+    end
+
+    def url_helpers
+      Rails.application.routes.url_helpers
+    end
+  end
+end

data/lib/view_spec/registry.rb

@@ -1,11 +1,11 @@
 module ViewSpec
   class Registry
     include Enumerable
-
-    delegate :each, to: :@specs
+    attr_reader :specs
+    delegate_missing_to :@specs
 
     def initialize
-      @specs = []
+      @specs = SpecCollection.new
       @source_files = {}
     end
 
@@ -21,34 +21,18 @@ module ViewSpec
       @source_files[path.to_s] ||= SourceFile.new(path)
     end
 
-    def find(subject)
-      find_where({subject:})
-    end
-
-    def has?(...)
-      !!find(...)
-    end
-
     def delete(subject)
       index = @specs.index { _1.subject == subject }
       @specs.delete_at(index) unless index.nil?
     end
 
     def clear!
+      @source_files.each do |key, file|
+        MethodSource.instance_variable_get(:@lines_for_file)&.delete(file.absolute_path.to_s)
+      end
+
       @specs.clear
       @source_files.clear
     end
-
-    def find_where(conditions)
-      where(conditions).first
-    end
-
-    def where(conditions)
-      @specs.filter do |spec|
-        !!conditions.each do |key, value|
-          break false unless spec.respond_to?(key) && (spec.public_send(key) == value)
-        end
-      end
-    end
   end
 end

data/lib/view_spec/renderable.rb

@@ -4,13 +4,16 @@ module ViewSpec
       attr_accessor :short_identifier
     end
 
-    def initialize(identifier, tpl = nil, &block)
+    delegate :source, :lang, to: :@executable
+
+    def initialize(identifier, executable, assigns: {})
       @identifier = identifier
-      @block = tpl ? -> { render inline: tpl } : block
+      @executable = executable
+      @assigns = assigns
     end
 
     def render_in(view_context)
-      render_context(view_context).instance_exec(&@block)&.strip&.html_safe
+      render_context(view_context).instance_exec(&@executable)&.strip&.html_safe
     end
 
     private
@@ -24,10 +27,8 @@ module ViewSpec
         view_context.instance_variable_set(:@current_template, current_template)
       end
 
-      view_context.assigns.each do |key, value|
-        view_context.define_singleton_method(key) do
-          instance_variable_get(:"@#{key}") || {}
-        end
+      view_context.assigns.merge(@assigns).each do |key, value|
+        view_context.define_singleton_method(key) { value }
       end
 
       view_context

data/lib/view_spec/scenario.rb

@@ -1,58 +1,14 @@
+require "redcarpet"
 module ViewSpec
-  class Scenario < DSL::Context
-    include DSL::Title
-    include DSL::Params
-    include DSL::Layout
-    include DSL::Controller
+  class Scenario < Entry
+    def preview(**options)
+      raise NoPreviewError, "no preview defined" if context.preview.nil?
 
-    class NoPreviewError < StandardError; end
-
-    def preview(tpl = nil, &block)
-      @preview = tpl || block
-    end
-
-    def render_preview(params: {}, assigns: {}, layout: false, raw: false)
-      assigns[:params] = resolve_params(params).to_h
-      html = render(renderable_preview, layout:, assigns:)
-
-      raw ? CGI.unescapeHTML(html) : html
-    end
-
-    def render_output(*args, **kwargs)
-      render_preview(*args, **kwargs, raw: true)
-    end
-
-    def name
-      @subject.to_s
-    end
-
-    def short_identifier
-      @subject.to_short_identifier
+      ScenarioPreview.new(self, context.preview, **options)
     end
 
     def to_param
       short_identifier
     end
-
-    def to_partial_path
-      "view_spec/scenario"
-    end
-
-    private
-
-    def renderable_preview
-      if @preview.is_a?(String)
-        Renderable.new(short_identifier, @preview)
-      elsif @preview.is_a?(Proc)
-        Renderable.new(short_identifier, &@preview)
-      else
-        raise NoPreviewError, "no preview defined for scenario `#{short_identifier}`"
-      end
-    end
-
-    def render(*args, layout: false, assigns: {}, **kwargs, &block)
-      layout = self.layout if layout == true
-      controller.render(*args, layout:, assigns:, **kwargs, &block)
-    end
   end
 end

data/lib/view_spec/scenario_collection.rb

@@ -0,0 +1,4 @@
+module ViewSpec
+  class ScenarioCollection < EntryCollection
+  end
+end

data/lib/view_spec/scenario_context.rb

@@ -0,0 +1,11 @@
+module ViewSpec
+  class ScenarioContext < Context
+    include DSL::Tests
+    include DSL::Title
+    include DSL::Notes
+    include DSL::Layout
+    include DSL::Params
+    include DSL::Preview
+    include DSL::Controller
+  end
+end

data/lib/view_spec/scenario_preview.rb

@@ -0,0 +1,30 @@
+module ViewSpec
+  class ScenarioPreview < Preview
+    delegate :source, :lang, to: :renderable
+
+    def initialize(entry, executable, **options)
+      @executable = executable
+      super(entry, **options)
+    end
+
+    def call(view_context = nil)
+      @entry.validate_params(@params)
+      @rendered ||= renderer(view_context).render(renderable, layout:)
+    end
+
+    def raw
+      CGI.unescapeHTML(to_s)
+    end
+
+    alias_method :to_s, :call
+    alias_method :to_str, :call
+
+    private
+
+    attr_reader :layout
+
+    def renderable
+      @renderable ||= Renderable.new(@entry.short_identifier, @executable, assigns: @assigns.to_h.merge(params:))
+    end
+  end
+end

data/lib/view_spec/source_file.rb

@@ -30,6 +30,22 @@ module ViewSpec
       absolute_path.to_s.end_with?("#{ViewSpec.config.spec_file_suffix}.rb")
     end
 
+    def lang_from_line(lineno, fallback)
+      unless lineno.nil?
+        source_line = line(lineno)
+        if source_line.present?
+          tag = Utils.heredoc_tag(source_line)
+          return tag.downcase.to_sym if tag.present?
+        end
+      end
+
+      fallback
+    end
+
+    def line(lineno)
+      File.readlines(absolute_path)[lineno.to_i - 1]
+    end
+
     alias_method :to_path, :to_s
     alias_method :to_pathname, :absolute_path
 
@@ -51,5 +67,11 @@ module ViewSpec
     def path_segments
       absolute_path.to_s.split("/")
     end
+
+    def read_line(lineno)
+      File.open(absolute_path, "r").each_with_index do |line_str, i|
+        return line_str if i + 1 == lineno
+      end
+    end
   end
 end

data/lib/view_spec/spec.rb

@@ -1,11 +1,5 @@
 module ViewSpec
-  class Spec < DSL::Context
-    include DSL::Title
-    include DSL::Layout
-    include DSL::Groups
-    include DSL::Scenarios
-    include DSL::Controller
-
+  class Spec < Entry
     attr_reader :subject, :source_file
 
     def initialize(source_file, subject, &block)
@@ -14,10 +8,6 @@ module ViewSpec
       super(subject, nil, &block)
     end
 
-    def short_identifier
-      @subject.to_short_identifier
-    end
-
     def lookup_path
       if @source_file.spec_file?
         @source_file.lookup_path
@@ -30,8 +20,8 @@ module ViewSpec
       lookup_path
     end
 
-    def to_partial_path
-      "view_spec/spec"
+    def previews?
+      scenarios(flatten: true).select { _1.preview? }.any?
     end
   end
 end

data/lib/view_spec/spec_collection.rb

@@ -0,0 +1,7 @@
+module ViewSpec
+  class SpecCollection < EntryCollection
+    def find(subject = nil, &block)
+      subject.nil? ? items.find(&block) : find_where({subject:})
+    end
+  end
+end

data/lib/view_spec/spec_context.rb

@@ -0,0 +1,11 @@
+module ViewSpec
+  class SpecContext < Context
+    include DSL::Title
+    include DSL::Notes
+    include DSL::Layout
+    include DSL::Groups
+    include DSL::Params
+    include DSL::Scenarios
+    include DSL::Controller
+  end
+end

data/lib/view_spec/test_case.rb

@@ -0,0 +1,10 @@
+module ViewSpec
+  class TestCase < ActiveSupport::TestCase
+    include TestHelpers
+
+    def render_preview(**params)
+      @rendered_content = Nokogiri::HTML.fragment(scenario.preview(params:).to_s)
+      @rendered_content
+    end
+  end
+end

data/lib/view_spec/test_helpers.rb

@@ -0,0 +1,23 @@
+module ViewSpec
+  module TestHelpers
+    begin
+      require "capybara/minitest"
+      include Capybara::Minitest::Assertions
+
+      def page
+        @page ||= Capybara::Node::Simple.new(rendered_content)
+      end
+    rescue LoadError
+      if ENV["DEBUG"]
+        warn("ViewSpec::TestHelpers: Add `capybara` to Gemfile to use Capybara assertions.")
+      end
+    end
+
+    attr_reader :rendered_content
+
+    def render_preview(preview)
+      @rendered_content = Nokogiri::HTML.fragment(preview.to_s)
+      @rendered_content
+    end
+  end
+end

data/lib/view_spec/types/symbol.rb

@@ -2,7 +2,7 @@ module ViewSpec
   module Types
     class Symbol < Type
       def cast(value)
-        value.to_sym
+        value&.to_sym
       end
     end
   end

data/lib/view_spec/utils.rb

@@ -4,6 +4,47 @@ module ViewSpec
       paths.map { File.absolute_path(_1, Rails.root) }
     end
 
-    module_function :normalize_paths
+    def create_namespace(ns, root = Object)
+      module_names = ns.split("::")
+      current_context = root
+      module_names.each do |module_name|
+        unless module_name == "ViewSpecs"
+          current_context.const_set(module_name, Module.new)
+        end
+      rescue
+      ensure
+        current_context = current_context.const_get(module_name)
+      end
+      current_context
+    end
+
+    def create_class(name, root = Object, base_class: nil, &block)
+      namespace_parts = name.camelize.split("::")
+      class_name = namespace_parts.pop
+      namespace = namespace_parts.join("::")
+
+      scope = create_namespace(namespace, root)
+      scope.const_set(class_name, Class.new(base_class))
+
+      klass = scope.const_get(class_name)
+      klass.instance_exec(&block) if block
+      klass
+    end
+
+    def heredoc_tag(source_line)
+      matches = source_line.match(/<<~?(?<tag>[A-Z_\d]+)/)
+      matches[:tag] if matches
+    end
+
+    def lang_from_source_line(source_line, fallback = nil)
+      if source_line.present?
+        tag = Utils.heredoc_tag(source_line)
+        tag.present? ? tag.downcase.to_sym : fallback
+      else
+        fallback
+      end
+    end
+
+    module_function :normalize_paths, :create_namespace, :create_class, :heredoc_tag
   end
 end

data/lib/view_spec/version.rb

@@ -1,3 +1,3 @@
 module ViewSpec
-  VERSION = "0.0.0"
+  VERSION = "0.0.1"
 end

data/lib/view_spec.rb

@@ -1,5 +1,6 @@
 require "zeitwerk"
 require "active_support"
+require "method_source"
 require "view_spec/version"
 
 loader = Zeitwerk::Loader.for_gem
@@ -11,8 +12,6 @@ loader.enable_reloading if ENV["RAILS_ENV"] == "development"
 loader.setup
 
 module ViewSpec
-  include DSL
-
   class << self
     def config
       @config ||= Config.instance
@@ -22,6 +21,19 @@ module ViewSpec
       yield config
     end
 
+    def register(subject, &block)
+      source_path = caller_locations(1..1).first.absolute_path
+      registry.add(source_path, subject, &block)
+    end
+
+    def registry
+      @registry ||= Registry.new
+    end
+
+    def specs
+      registry.specs
+    end
+
     def load!
       registry.clear!
 
@@ -32,6 +44,8 @@ module ViewSpec
 
       Utils.normalize_paths(config.spec_files).each { load _1 }
     end
+
+    alias_method :spec, :register
   end
 end