nanoc-spec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f909ce885ffe4562d8ecb52f757c4b6d99dd42547c6b890f6c3778ab08dc6f26
+  data.tar.gz: 43d0076bf889953457b8ede4a53657698c96bd92f672c4f1d26b03bf1d02e0de
+SHA512:
+  metadata.gz: 952919fa35ba23aeca9eed60aedf47b9b3b862765f3548d2745969f5277ebcc230d77f4e4f5123566096acfa6628b428fc28f2f35df75cd23981ccad414c192f
+  data.tar.gz: dbbf3c6f832d11c84f6c9a4f975521de27982e8455e9a435ad22aed83ae7b87d78781ffbc17e11adcb0b53b80a6612d8d6c78ce015e7547615ae8d80f1eea054

data/NEWS.md

@@ -0,0 +1,5 @@
+# nanoc-spec news
+
+## 0.0.1 (2019-11-16)
+
+Initial release.

data/README.md

@@ -0,0 +1,17 @@
+# nanoc-spec
+
+This provides `Nanoc::Spec`, which contains a bunch of functionality that facilitates writing tests for [Nanoc](https://nanoc.ws).
+
+## Installation
+
+Add `nanoc-spec` to the `nanoc` group of your Gemfile:
+
+```ruby
+group :nanoc do
+  gem 'nanoc-spec'
+end
+```
+
+## Usage
+
+Don’t — for now.

data/lib/nanoc-spec.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require 'nanoc/spec'

data/lib/nanoc/spec.rb

@@ -0,0 +1,246 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Spec
+  end
+end
+
+require 'nanoc/spec/version'
+
+module Nanoc
+  module Spec
+    module Helper
+      def chdir(dir)
+        here = Dir.getwd
+        Dir.chdir(dir)
+        yield
+      ensure
+        Dir.chdir(here)
+      end
+
+      def command?(cmd)
+        TTY::Which.exist?(cmd)
+      end
+
+      def skip_unless_have_command(cmd)
+        skip "Could not find external command \"#{cmd}\"" unless command?(cmd)
+      end
+
+      def skip_unless_gem_available(gem)
+        require gem
+      rescue LoadError
+        skip "Could not load gem \"#{gem}\""
+      end
+
+      def sleep_until(max: 3.0)
+        start = Time.now
+        loop do
+          diff = (Time.now - start).to_f
+          if diff > max
+            raise "Waited for #{diff}s for condition to become true, but it never did"
+          end
+
+          break if yield
+
+          sleep 0.1
+        end
+      end
+    end
+
+    class HelperContext
+      # @return [Nanoc::Core::DependencyTracker]
+      attr_reader :dependency_tracker
+
+      attr_reader :erbout
+
+      # @param [Module] mod The helper module to create a context for
+      def initialize(mod)
+        @mod = mod
+
+        @erbout = +''
+        @action_sequence = {}
+        @config = Nanoc::Core::Configuration.new(dir: Dir.getwd).with_defaults
+        @reps = Nanoc::Core::ItemRepRepo.new
+        @items = Nanoc::Core::ItemCollection.new(@config)
+        @layouts = Nanoc::Core::LayoutCollection.new(@config)
+        @dependency_tracker = Nanoc::Core::DependencyTracker.new(Object.new)
+        @compiled_content_store = Nanoc::Core::CompiledContentStore.new
+        @action_provider = new_action_provider
+      end
+
+      # Creates a new item and adds it to the site’s collection of items.
+      #
+      # @param [String] content The uncompiled item content
+      #
+      # @param [Hash] attributes A hash containing this item's attributes
+      #
+      # @param [Nanoc::Core::Identifier, String] identifier This item's identifier
+      #
+      # @return [Nanoc::Core::CompilationItemView] A view for the newly created item
+      def create_item(content, attributes, identifier)
+        item = Nanoc::Core::Item.new(content, attributes, identifier)
+        @items = @items.add(item)
+        self
+      end
+
+      # Creates a new layout and adds it to the site’s collection of layouts.
+      #
+      # @param [String] content The raw layout content
+      #
+      # @param [Hash] attributes A hash containing this layout's attributes
+      #
+      # @param [Nanoc::Core::Identifier, String] identifier This layout's identifier
+      #
+      # @return [Nanoc::Core::CompilationItemView] A view for the newly created layout
+      def create_layout(content, attributes, identifier)
+        layout = Nanoc::Core::Layout.new(content, attributes, identifier)
+        @layouts = @layouts.add(layout)
+        self
+      end
+
+      # Creates a new representation for the given item.
+      #
+      # @param [Nanoc::Core::CompilationItemView] item The item to create a represetation for
+      #
+      # @param [String] path The path of the `:last` snapshot of this item representation
+      # @param [Symbol] rep The rep name to create
+      def create_rep(item, path, rep = :default)
+        rep = Nanoc::Core::ItemRep.new(item._unwrap, rep)
+        rep.paths[:last] = [path]
+        @reps << rep
+        self
+      end
+
+      # @return [Object] An object that includes the helper functions
+      def helper
+        mod = @mod
+        klass = Class.new(Nanoc::Core::Context) { include mod }
+        klass.new(assigns)
+      end
+
+      def item=(item)
+        @item = item ? item._unwrap : nil
+      end
+
+      def item_rep=(item_rep)
+        @item_rep = item_rep ? item_rep._unwrap : nil
+      end
+
+      # @return [Nanoc::Core::MutableConfigView]
+      def config
+        assigns[:config]
+      end
+
+      # @return [Nanoc::Core::CompilationItemView, nil]
+      def item
+        assigns[:item]
+      end
+
+      # @return [Nanoc::Core::BasicItemRepView, nil]
+      def item_rep
+        assigns[:item_rep]
+      end
+
+      # @return [Nanoc::Core::ItemCollectionWithRepsView]
+      def items
+        assigns[:items]
+      end
+
+      # @return [Nanoc::Core::LayoutCollectionView]
+      def layouts
+        assigns[:layouts]
+      end
+
+      def action_sequence_for(obj)
+        @action_sequence.fetch(obj, [])
+      end
+
+      def update_action_sequence(obj, memory)
+        @action_sequence[obj] = memory
+      end
+
+      def compiled_content_store
+        view_context.compiled_content_store
+      end
+
+      private
+
+      def view_context
+        compilation_context =
+          Nanoc::Core::CompilationContext.new(
+            action_provider: @action_provider,
+            reps: @reps,
+            site: site,
+            compiled_content_cache: Nanoc::Core::CompiledContentCache.new(config: @config),
+            compiled_content_store: @compiled_content_store,
+          )
+
+        Nanoc::Core::ViewContextForCompilation.new(
+          reps: @reps,
+          items: @items,
+          dependency_tracker: @dependency_tracker,
+          compilation_context: compilation_context,
+          compiled_content_store: @compiled_content_store,
+        )
+      end
+
+      def new_action_provider
+        Class.new(Nanoc::Core::ActionProvider) do
+          def self.for(_context)
+            raise NotImplementedError
+          end
+
+          def initialize(context)
+            @context = context
+          end
+
+          def rep_names_for(_item)
+            [:default]
+          end
+
+          def action_sequence_for(obj)
+            @context.action_sequence_for(obj)
+          end
+
+          def snapshots_defs_for(_rep)
+            [Nanoc::Core::SnapshotDef.new(:last, binary: false)]
+          end
+        end.new(self)
+      end
+
+      def new_compiler_for(site)
+        Nanoc::Core::CompilerLoader.new.load(site, action_provider: @action_provider)
+      end
+
+      def site
+        @_site ||=
+          Nanoc::Core::Site.new(
+            config: @config,
+            code_snippets: [],
+            data_source: Nanoc::Core::InMemoryDataSource.new(@items, @layouts),
+          )
+      end
+
+      def assigns
+        {
+          config: Nanoc::Core::MutableConfigView.new(@config, view_context),
+          item_rep: @item_rep ? Nanoc::Core::CompilationItemRepView.new(@item_rep, view_context) : nil,
+          item: @item ? Nanoc::Core::CompilationItemView.new(@item, view_context) : nil,
+          items: Nanoc::Core::ItemCollectionWithRepsView.new(@items, view_context),
+          layouts: Nanoc::Core::LayoutCollectionView.new(@layouts, view_context),
+          _erbout: @erbout,
+        }
+      end
+    end
+
+    module HelperHelper
+      def ctx
+        @_ctx ||= HelperContext.new(described_class)
+      end
+
+      def helper
+        @_helper ||= ctx.helper
+      end
+    end
+  end
+end

data/lib/nanoc/spec/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Nanoc
+  module Spec
+    VERSION = '0.0.1'
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: nanoc-spec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Denis Defreyne
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-11-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nanoc-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.13
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.11'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.11.13
+description: Provides Nanoc::Spec, containing functionality for writing tests for
+  Nanoc
+email: denis+rubygems@denis.ws
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- NEWS.md
+- README.md
+- lib/nanoc-spec.rb
+- lib/nanoc/spec.rb
+- lib/nanoc/spec/version.rb
+homepage: https://nanoc.ws/
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Testing functionality for Nanoc
+test_files: []