prolog-services-replace_content 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9dd8722087ca2e53d4e72dd77e1f6ae1213f6168
+  data.tar.gz: af89b216099e0209bade77ac66a70838d3b6817c
+SHA512:
+  metadata.gz: d32288b39c0f49b71e9998d13c79e11f63e2864c9c9f77e3319de7eed435c94fa19c74512c597e4fe7e92e4d53d01fd3994879ee645174540319a3f44aa4ed70
+  data.tar.gz: d840e8bfe0bb3162e705e5cef4f11c8273cb77be1a94432eeb86e746bbf6987664fb846b3e5d496de1a7730140f78bbf04cad102dd0b944a816640a3ebb80e44

data/.codeclimate.yml

@@ -0,0 +1,16 @@
+---
+engines:
+  duplication:
+    enabled: true
+    config:
+      languages:
+      - ruby
+  fixme:
+    enabled: true
+  rubocop:
+    enabled: true
+ratings:
+  paths:
+  - "**.rb"
+exclude_paths:
+- test/

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/o-rdoc/
+/log/
+!/log/.keep

data/.rubocop.yml

@@ -0,0 +1,43 @@
+
+# CodeClimate runs an older version of RuboCop, which apparently doesn't
+# understand the `AllCops` setting. So we do it The Hard Way.
+
+Metrics/LineLength:
+  Exclude:
+    - Rakefile
+    - prolog-services-replace_content.gemspec
+
+Style/PercentLiteralDelimiters:
+  Exclude:
+    - prolog-services-replace_content.gemspec
+
+Style/PercentQLiterals:
+  Exclude:
+    - prolog-services-replace_content.gemspec
+
+Style/StringLiterals:
+  Exclude:
+    - Rakefile
+    - prolog-services-replace_content.gemspec
+    - bin/console
+
+Style/UnneededPercentQ:
+  Exclude:
+    - prolog-services-replace_content.gemspec
+
+Style/WordArray:
+  Exclude:
+    - Rakefile
+
+# 'Real' settings follow. ###################################
+
+AllCops:
+  TargetRubyVersion: 2.3
+
+Metrics/AbcSize:
+  Exclude:
+    - test/prolog/use_cases/propose_edit_contribution_test.rb
+
+Metrics/MethodLength:
+  Exclude:
+    - test/prolog/use_cases/propose_edit_contribution_test.rb

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+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.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at jdickey@seven-sigma.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in prolog-services-replace_content.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Jeff Dickey
+
+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,236 @@
+# Prolog::Services::ReplaceContent
+
+[ ![Codeship Status for TheProlog/prolog-services-replace_content](https://codeship.com/projects/de342330-da58-0133-0093-5a647b2fc712/status?branch=master)](https://codeship.com/projects/143778) [![Code Climate](https://codeclimate.com/github/TheProlog/prolog-services-replace_content/badges/gpa.svg)](https://codeclimate.com/github/TheProlog/prolog-services-replace_content) [![Test Coverage](https://codeclimate.com/github/TheProlog/prolog-services-replace_content/badges/coverage.svg)](https://codeclimate.com/github/TheProlog/prolog-services-replace_content/coverage) [![Issue Count](https://codeclimate.com/github/TheProlog/prolog-services-replace_content/badges/issue_count.svg)](https://codeclimate.com/github/TheProlog/prolog-services-replace_content) [![Dependency Status](https://gemnasium.com/TheProlog/prolog-services-replace_content.svg)](https://gemnasium.com/TheProlog/prolog-services-replace_content)
+
+
+This Gem was extracted from an internally-developed application, which should somewhat explain the namespacing.
+
+The Gem provides an (extremely) simple API for replacing a substring of "existing" HTML content, specified by zero-based endpoint indexes, with valid HTML content, which may be partly or completely comprised of embedded HTML. Detailed API usage is documented below.
+
+**Important:** The initial release of this Gem *only* supports HTML for source and replacement content; no Markdown content is supported. This means that, for example,. specifying a simple string with­out tags as replacement content will attempt to replace the selected range with *just that text*; if that causes the resulting HTML to be invalid, it will be reported as an error.
+
+A future release of this Gem is expected to support specification of source and/or replacement content in *either* HTML or Markdown (which, remember, is a proper superset of HTML). The tools presently available for supporting this, however, are presently stumped by several corner cases we have devised that are likely enough to occur "in the wild" to be of serious concern.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'prolog-services-replace_content'
+```
+
+And then execute:
+
+```
+$ bundle
+```
+
+Or install it yourself as:
+
+```
+$ gem install prolog-services-replace_content
+```
+
+## Usage
+
+```ruby
+require 'prolog/services/replace_centent'
+
+content = '<p>This is a <em>simple</em> test.</p>'
+endpoint_begin = content.index ' <em>'
+endpoint_end = content.index ' test.'
+
+# ...
+
+endpoints = (endpoint_begin..endpoint_end)
+converter = Prolog::Services::ReplaceContent.new(content: content,
+                                                 endpoints: endpoints,
+                                                 replacement: 'basic' )
+
+# Would replacing the specified range with the specified content result in valid
+# and well-formed HTML?
+converter.valid? # => true
+
+# Replace content without using any surrounding markers
+converter.convert # => true
+converter.converted_content # => '<p>Tis is a basic test.</p>'
+
+converter.markers = :a
+converter.convert # need to repeat this after changing markers
+converter.converted_content
+# => '<p>This is a <a id="selection-begin"></a>basic<a id="selection-end"></a> test.</p>'
+converter.errors.empty? # => true
+converter.valid? # => true
+
+# Conversion inserting marker tag pairs (tag symbol required; text optional)
+
+converter.markers = :span, 'testing-again'
+converter.convert
+converter.converted_content
+# => '<p>This is a <span id="testing-again-begin"></span>basic<span id="testing-again-end"></span> test.</p>'
+
+# Error conditions
+#   Error Condition #1: Bad endpoints
+
+content = '<p>This is a <em>simple</em> test.</p>'
+endpoints = (15..28)
+converter = Prolog::Services::ReplaceContent.new(content: content,
+                                                 endpoints: endpoints,
+                                                 replacement: 'basic' )
+# with these params, `#converted_content` would return something like
+#    '<p>This is a <e<a id="foo"></a>m>simple</em><a id="foo-end"></a> test.</p>'
+# if we let it. Nope; no joy.
+
+converter.valid? # <= false
+converter.errors # <= { endpoints: ['force invalid HTML'] }
+converter.convert # <= false
+converter.converted_content # <= :failed_conversion ### *NOT* a string!
+
+#   Error Condition #2: Bad source content
+converter.content = '<p>This is bad content.</div>'
+converter.valid? # => false
+converter.convert # => false
+converter.errors # => { content => ['invalid HTML'] }
+converter.converted_content # => :failed_conversion
+
+#   Error Condition #3: Replacement forces bad HTML
+converter.content = '<p>This is <em>simple</em> content.</p>'
+converter.replacement = 'bad '
+converter.endpoints = (11..14)
+# would convert to '<p>This is bad>simple</em> content.</p>'
+converter.valid? # <= false
+converter.errors # => { replacement: ['invalidates HTML'] }
+converter.convert # => false
+converter.converted_content # <= :failed_conversion
+
+#   Error Condition #4: Attributes changed but `#convert` not called
+converter = Prolog::Services::ReplaceContent.new(content: content,
+                                                 endpoints: endpoints,
+                                                 replacement: 'basic' )
+
+converter.replacement = 'simplistic'
+converter.valid? # => false
+converter.errors # => { conversion: ['not called'] }
+```
+
+
+
+## API Reference
+
+### Initialisation
+
+#### `#initialize(**params = {})`
+
+Creates an instance of the converter class, populating the `#content`, `#endpoints`, and `#replacement` attributes of the instance based on the specified values. Any of these may be omitted, which has the effect of using default values of `''`, `(-1..-1)`, and `''`, respectively.
+
+### Attribute getters and setters
+
+#### `#content`
+
+The HTML content specified as *source content* for the conversion, as specified either from the initialiser or the `#content=` method. Is guaranteed to return either an empty string or valid HTML.
+
+#### `#content=(str)`
+
+Specifies HTML *source content* that will be used for the conversion in `#convert`. Specifying a new value using this method, and then calling `#converted_content` without having previously called `#convert`, will trigger an error condition (see `#convert` and/or `#errors` for details).
+
+#### `#endpoints`
+
+Returns the endpoints specified for the range within the `#content` which is to be replaced with the `#replacement_content`. This is a range of integers that follow Ruby conventions for string indexing (zero is the start of the string; `-1` is the last character in the string, `-2` is the second-to-last, etc). If not set by either `#initialize` or `#endpoints=`, defaults to `(-1..-1)`, which is rarely what is desired.
+
+#### `#endpoints=(range)`
+
+Assigns the endpoints of the range within the source `#content` which is to be replaced by the re­placement content. Can be either an integer (specifying the ending endpoint, where the starting endpoint is set to zero, the beginning of the string) or a range of non-negative integers. If the speci­fied value is invalid (either because it is not a valid range of non-negative integers or because the ending endpoint exceeds the length of the `#content` when `#convert` is called), will default to `(-1..-1)` and cause an error to be reported (see `#errors`, below).
+
+#### `#markers=`
+
+Specifies the details of the marker tag pairs to be used to wrap the content within the endpoints. If not explicitly set, no such tag pairs will be used. May be set using a symbolic HTML tag name (e.g. `:span` for the HTML `<span>` tag pair) and, optionally, an "identifier" string.
+
+Examples:
+
+```ruby
+# Setting the HTML tag used for the tag pairs to the `<a>` tag
+# ...
+converter.markers = :a
+converter.convert
+converter.converted_content
+# => '<p>This is a <a id="selection-begin"></a>basic<a id="selection-end"></a> test.</p>'
+
+# Setting the markers to the '<a>' tag and the identifier prefix to 'mambo-no-5'
+converter.markers = :a, 'mambo-no-5'
+converter.convert
+converter.converted_content
+# => '<p>This is a <a id="mambo-no-5-begin"></a>basic<a id="mambo-no-5-end"></a> test.</p>'
+
+# Setting the HTML tag without setting the identifier resets the latter to 'selection'
+converter.markers = :span
+converter.convert
+converter.converted_content
+# => '<p>This is a <span id="selection-begin"></span>basic<span id="selection-end"></span> test.</p>'
+
+```
+
+**Note** that setting the markers, as with setting any of the other attributes, invalidates any previous conversion and requires the `#convert` method to be called again prior to calling `#converted_content`.
+
+#### `#replacement`
+
+Returns the content string specified to replace the existing content within the endpoints, specified by either `#initialize` or `#replacement=`. This is guaranteed to be either an empty string or a valid HTML string.
+
+#### `#replacement=(str)`
+
+Specifies content, as an HTML string, that will be used to replace an existing range of content by a successful call to `#convert`. Assigning to this, or any of the other attributes and then calling `#converted_content` without first calling `#convert` will report an error (see `#convert` and/or `#errors` for details).
+
+If a string without HTML tags is specified, then it will be used literally; if replacing the content between the endpoints with that replacement string results in invalid HTML, then that also will cause an error to be reported.
+
+The default value is the empty string.
+
+### Action methods
+
+#### `#convert`
+
+Inserts marker tag pairs, if specified (see `#markers`), in the source content at the specified end­points, and then replaces the content corresponding to the original endpoints (whether or not bounded by marker tag pairs) with the `#replacement_content`, then ensures that the resulting HTML is valid and well-formed. If no `#markers` were specified, removes them from the resulting HTML before assigning it to the `converted_content` attribute.
+
+If the conversion was successful in all respects, returns `true`; else returns `false` and sets internal `errors` describing the failure which aborted the conversion.
+
+### Query methods
+
+#### `#converted_content`
+
+Returns the product of the `#convert` method if that was successful, or `:failed_conversion` if it was not. Will also return `:failed_conversion` if not all prerequisite attributes (for content, endpoints, and replacement content) were set before calling `#convert`, or if any of these attributes were set but `#convert` was not called before calling `#converted_content`.
+
+#### `#errors`
+
+Returns a Hash-like object whose keys are attribute symbols (`:content`, `:endpoints`, `:replacement`), or the additional key `:conversion`, and whose values are an Array of simple strings identifying an error condition.
+
+If the instance is valid, and no error condition has yet been triggered, then this method will return an empty Hash-like instance.
+
+**Important Note:** Even though only one possible value for each key has yet been identified, that may change in future; with that in mind, the value associated with each key will always be an Array.
+
+The keys and values for the Hash are enumerated below:
+
+| Key            | Value                    |
+| -------------- | ------------------------ |
+| `:conversion`  | `['not called']`         |
+| `:content`     | `['invalid HTML']`       |
+| `:endpoints`   | `['force invalid HTML']` |
+| `:replacement` | `['invalidates HTML']`   |
+
+
+
+#### `#valid?`
+
+Returns `true` if no attributes have been modified since a successful call to `#convert`. If no call to `#convert` has yet been made, regardless of attribute state, returns `false`.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 `rake install`. *If you are a maintainer with write access to this repository,* to release a new version, update the version number in `version.rb`, and then run `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). *Non-maintainers must not run this command*, and attempting to do so will fail.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/TheProlog/prolog-services-markdown_to_html. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,48 @@
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+require 'rake/tasklib'
+require 'flay_task'
+require 'flog'
+require 'flog_task'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = [
+    'lib/**/*.rb',
+    'test/**/*.rb'
+  ]
+  task.formatters = ['simple', 'd']
+  task.fail_on_error = true
+  # task.options << '--rails'
+  task.options << '--display-cop-names'
+end
+
+Reek::Rake::Task.new do |t|
+  t.config_file = 'config.reek'
+  t.source_files = '{app,lib,test}/**/*.rb'
+  t.reek_opts = '--sort-by smelliness -s'
+end
+
+FlayTask.new do |t|
+  t.verbose = true
+  t.dirs = %w(app lib)
+end
+
+FlogTask.new do |t|
+  t.verbose = true
+  t.threshold = 200 # default is 200
+  t.instance_variable_set :@methods_only, true
+  t.dirs = %w(app lib) # Look, Ma; no tests! Run the tool manually every so often for those.
+end
+
+task(:default).clear
+task default: [:test, :rubocop, :flay, :flog, :reek]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "prolog/services/replace_content"
+
+# 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

data/bin/install-pandoc-from-cabal

@@ -0,0 +1,14 @@
+#!/bin/bash
+find ~/.cabal/bin/pandoc 2>&1 >/dev/null && exit 0
+# Not there; build it
+mkdir /tmp/$$
+pushd /tmp/$$
+wget https://github.com/jgm/pandoc/archive/1.17.0.3.tar.gz
+mv 1.17.0.3.tar.gz pandoc-1.17.0.3.tar.gz
+tar zxf pandoc-1.17.0.3.tar.gz
+rm pandoc-1.17.0.3.tar.gz
+cabal update
+cabal install --user pandoc regex-posix regex-compat
+export PATH=~/.cabal/bin:$PATH
+echo Leaving `pwd`
+popd

data/bin/setup

@@ -0,0 +1,9 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+gem install nokogiri -- --use-system-libraries --with-xml2-config=/usr/bin/xml2-config --with-xslt-config=/usr/bin/xslt-config
+gem install bundler flay flog reek rubocop pry-byebug simplecov awesome_print codeclimate-test-reporter minitest-matchers minitest-reporters minitest-tagz pandoc-ruby prolog-services-markdown_to_html semantic_logger
+bundle config build.nokogiri --use-system-libraries
+bundle install

data/config.reek

@@ -0,0 +1,8 @@
+
+LongParameterList:
+  max_params: 4  # If it's good enough for Sandi, it's good enough for us.
+
+NestedIterators:
+  max_allowed_nesting: 2
+  ignore_iterators:
+    - lambda

data/lib/prolog/services/replace_content.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require 'ox'
+
+require 'prolog/services/replace_content/splitter/factory'
+require 'prolog/services/replace_content/version'
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    # FIXME: Reek thinks this has :reek:TooManyInstanceVariables; cleanup soonn.
+    class ReplaceContent
+      attr_reader :content, :endpoints, :errors, :markers, :replacement
+
+      def initialize(content: '', endpoints: (-1..-1), replacement: '')
+        @content = content
+        @endpoints = endpoints
+        @replacement = replacement
+        @content_after_conversion = nil
+        @errors = {}
+        self
+      end
+
+      def convert
+        validate
+        return false unless valid?
+        set_converted_content
+        valid?
+      end
+      # rubocop:enable Metrics/AbcSize, Metrics/MethodLength
+
+      def converted_content
+        errors[:conversion] = ['not called'] unless @content_after_conversion
+        @content_after_conversion || :oops
+      end
+
+      # Setting markers also invalidates the conversion.
+      def markers=(*params)
+        @content_after_conversion = nil
+        @markers = Array(params).flatten
+      end
+
+      def valid?
+        errors.empty?
+      end
+
+      def self.set_content(obj, content)
+        new endpoints: obj.endpoints, replacement: obj.replacement,
+            content: content
+      end
+
+      def self.set_endpoints(obj, endpoints)
+        new content: obj.content, replacement: obj.replacement,
+            endpoints: endpoints
+      end
+
+      def self.set_replacement(obj, replacement)
+        new content: obj.content, endpoints: obj.endpoints,
+            replacement: replacement
+      end
+
+      private
+
+      def build_converted_content
+        replace_inner_content_in splitter.source
+      end
+
+      def replace_inner_content_in(markup)
+        markup.sub(splitter.inner, replacement)
+      end
+
+      def set_converted_content
+        html = build_converted_content
+        @content_after_conversion = html if validate_markup(html, :replacement)
+        @content_after_conversion
+      end
+
+      def parse_with_comments
+        comment = '<!-- -->'
+        twiddled = splitter(comment).source
+        ret = Ox.parse twiddled # raises on most errors
+        ret
+      end
+
+      def splitter(marker = Splitter::Symmetric::DEFAULT_MARKER)
+        ret = Splitter::Factory.call(self, marker)
+        ret
+      end
+
+      def validate
+        validate_content && validate_endpoints
+      end
+
+      def validate_content
+        validate_markup @content, :content
+      end
+
+      def validate_markup(markup, error_key)
+        Ox.parse markup
+        true
+      rescue Ox::ParseError
+        errors[error_key] = ['invalid']
+        false
+      end
+
+      def _invalidate_endpoints
+        errors[:endpoints] = %w(invalid)
+        false
+      end
+
+      def validate_endpoints
+        parse_with_comments
+        true
+      rescue Ox::ParseError
+        _invalidate_endpoints
+      rescue RangeError
+        _invalidate_endpoints
+      end
+    end # class Prolog::Services::ReplaceContent
+  end
+end

data/lib/prolog/services/replace_content/splitter/factory.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require_relative './paired'
+require_relative './symmetric'
+require_relative './splitter_params'
+require_relative './paired_params'
+require_relative './symmetric_params'
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # Should we use a symmetric or paired (identifier) splitter?
+        class Factory
+          # Methods independent of any instance state.
+          module Internals
+            def self.splitter_with_markers(data)
+              Paired.new _splitter_marker_params(data)
+            end
+
+            def self.symmetric_splitter(data, marker)
+              Symmetric.new _symmetric_marker_params(data, marker)
+            end
+
+            def self._build_splitter_marker_params(data)
+              markers = data.markers
+              identifier = _splitter_identifier_from markers
+              [data.content, data.endpoints, markers[0], identifier]
+            end
+
+            def self._splitter_identifier_from(markers)
+              markers[1] || Paired::DEFAULT_ID
+            end
+
+            def self._splitter_marker_params(data)
+              params = _build_splitter_marker_params(data)
+              PairedSplitterParams.new(*params)
+            end
+
+            def self._symmetric_marker_params(data, marker)
+              SymmetricSplitterParams.new data.content, data.endpoints, marker
+            end
+          end # module Internals
+          private_constant :Internals
+
+          def self.call(data, marker)
+            return Internals.splitter_with_markers(data) if data.markers
+            Internals.symmetric_splitter data, marker
+          end
+        end # class Prolog::Services::ReplaceContent::Splitter::Factory
+      end
+    end # class Prolog::Services::ReplaceContent
+  end
+end

data/lib/prolog/services/replace_content/splitter/paired.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # A "paired" splitter inserts an empty pair of HTML tags before the
+        # selected content, and another such empty tag pair afterwards. The tag
+        # pairs each have an ID attribute string which ends in '-begin' for the
+        # tag pair before the selection, and '-end' for the tag pair after the
+        # content. The default for the tag is the anchor tag (:a), though that
+        # may be changed by specifying a synbolic `tag` parameter (such as
+        # :span). The default text before the '-begin'/'-end' text in the ID
+        # attribute strings is 'selection'; that may similary be changed by
+        # specifying the `identifier` parameter to the initialiser.
+        class Paired
+          DEFAULT_ID = 'selection'
+
+          def initialize(content:, endpoints:, tag: :a, identifier: DEFAULT_ID)
+            @content = content
+            @endpoints = endpoints
+            @identifier = identifier
+            @tag = tag
+            self
+          end
+
+          def inner
+            content[endpoints]
+          end
+
+          def source
+            parts.join
+          end
+
+          private
+
+          attr_reader :content, :endpoints, :identifier, :tag
+
+          def leading_content
+            content[0...endpoints.begin]
+          end
+
+          def trailing_content
+            content[endpoints.end..-1]
+          end
+
+          def leading_marker
+            marker :begin
+          end
+
+          def trailing_marker
+            marker :end
+          end
+
+          def marker(which_end)
+            format_str = %(<%s id="%s-%s"></%s>)
+            format format_str, tag, identifier, which_end, tag
+          end
+
+          def parts
+            [leading_content, leading_marker, inner, trailing_marker,
+             trailing_content]
+          end
+        end # class Prolog::Services::ReplaceContent::Splitter::Paired
+      end
+    end # class Prolog::Services::ReplaceContent
+  end
+end

data/lib/prolog/services/replace_content/splitter/paired_params.rb

@@ -0,0 +1,22 @@
+
+# frozen_string_literal: true
+require_relative './splitter_params'
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # Builds splitter params for symmetric splitter; same marker text before
+        # and after selected content.
+        class PairedSplitterParams < SplitterParams
+          def initialize(content, endpoints, tag, identifier)
+            super content, endpoints
+            add(tag: tag, identifier: identifier)
+            self
+          end
+        end # class ...::ReplaceContent::Splitter::PairedSplitterParams
+      end
+    end # class Prolog::Services::ReplaceContent::SplitterParams
+  end
+end

data/lib/prolog/services/replace_content/splitter/splitter_params.rb

@@ -0,0 +1,27 @@
+
+# frozen_string_literal: true
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # Simple class to move splitter parameter munging out of ReplaceContent.
+        class SplitterParams
+          def initialize(content, endpoints)
+            @params = { content: content, endpoints: endpoints }
+            self
+          end
+
+          def add(**extra_params)
+            @params.merge! extra_params
+            self
+          end
+
+          def to_hash
+            @params
+          end
+        end # class Prolog::Services::ReplaceContent::Splitter::SplitterParams
+      end
+    end # class Prolog::Services::ReplaceContent::SplitterParams
+  end
+end

data/lib/prolog/services/replace_content/splitter/symmetric.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # A "symmetric" splitter inserts the same marker text before and after
+        # the selected range. This defaults to an empty string, but can be any
+        # simple string.
+        class Symmetric
+          DEFAULT_MARKER = ''
+
+          attr_reader :inner, :source
+
+          # Methods neither affecting nor affected by instance state.
+          module Internals
+            def self.build_inner(content, endpoints, marker)
+              [marker, marker].join content[endpoints]
+            end
+          end
+          private_constant :Internals
+
+          # Simplemindedly splits content string based on endpoints, returning
+          # bounding segments (not including substring *within* endpoints).
+          # Nobody should care what the marker actually is; just that it wrapps
+          # the `inner` value and makes the combination unique within the
+          # content.
+          class Parts
+            def self.parts(content, endpoints)
+              _twiddle(_split(content.dup, endpoints))
+            end
+
+            def self._marker
+              'z|q|x' * 8
+            end
+
+            def self._split(working, endpoints)
+              marker = _marker
+              working[endpoints] = marker
+              working.split marker
+            end
+
+            def self._twiddle(items)
+              return ['', ''] if items.empty?
+              items
+            end
+          end # class Prolog::Services::ReplaceContent::ContentSplitter::Parts
+
+          def initialize(content:, endpoints:, marker: DEFAULT_MARKER)
+            @inner = Internals.build_inner(content, endpoints, marker)
+            @source = rebuild_source(content, endpoints)
+            self
+          end
+
+          private
+
+          def rebuild_source(content, endpoints)
+            Parts.parts(content, endpoints).join inner
+          end
+        end # class Prolog::Services::ReplaceContent::Splitter::Symmetric
+      end
+    end # class Prolog::Services::ReplaceContent
+  end
+end

data/lib/prolog/services/replace_content/splitter/symmetric_params.rb

@@ -0,0 +1,23 @@
+
+
+# frozen_string_literal: true
+require_relative './splitter_params'
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      module Splitter
+        # Builds splitter params for symmetric splitter; same marker text before
+        # and after selected content.
+        class SymmetricSplitterParams < SplitterParams
+          def initialize(content, endpoints, marker)
+            super content, endpoints
+            add(marker: marker)
+            self
+          end
+        end # class ...::ReplaceContent::Splitter::SymmetricSplitterParams
+      end
+    end # class Prolog::Services::ReplaceContent::SplitterParams
+  end
+end

data/lib/prolog/services/replace_content/version.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Prolog
+  module Services
+    # Replaces content within an HTML string based on endpoints and content.
+    class ReplaceContent
+      VERSION = '0.1.2'
+    end
+  end
+end

data/prolog-services-replace_content.gemspec

@@ -0,0 +1,53 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'prolog/services/replace_content/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'prolog-services-replace_content'
+  spec.version       = Prolog::Services::ReplaceContent::VERSION
+  spec.authors       = ['Jeff Dickey']
+  spec.email         = ['jdickey@seven-sigma.com']
+
+  spec.summary       = %q{Replaces HTML within a specified range with HTML replacement content.}
+  # TOODOO should be an obvious typo; added to silence CodeClimate scan.
+  # spec.description   = %q{TOODOO: Write a longer description or delete this line.}
+  spec.homepage      = 'https://github.com/TheProlog/prolog-services-replace_content'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = 'TOODOO: Set to 'http://mygemserver.com''
+  # else
+  #   raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  # spec.add_dependency 'pandoc-ruby', '~> 2'
+  # spec.add_dependency 'prolog-services-markdown_to_html', '~> 1.0'
+  spec.add_dependency 'semantic_logger', '~> 3.2'
+  spec.add_dependency 'ox', '~> 2.3'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 11'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+
+  spec.add_development_dependency "minitest-matchers", "~> 1.4"
+  spec.add_development_dependency "minitest-reporters", "~> 1.0"
+  spec.add_development_dependency "minitest-tagz", "~> 1.2"
+  spec.add_development_dependency "flay", "~> 2.6"
+  spec.add_development_dependency "flog", "~> 4.3", ">= 4.3.2"
+  spec.add_development_dependency "reek", "~> 4.0"
+  spec.add_development_dependency "rubocop", "0.39.0"
+  spec.add_development_dependency "simplecov", "~> 0.10"
+  spec.add_development_dependency "pry-byebug", "~> 3.2"
+  spec.add_development_dependency "pry-doc", "~> 0.8"
+  spec.add_development_dependency "colorize", "~> 0.7", ">= 0.7.7"
+  spec.add_development_dependency "awesome_print", "~> 1.6", ">= 1.6.1"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 0.5"
+end

metadata

@@ -0,0 +1,338 @@
+--- !ruby/object:Gem::Specification
+name: prolog-services-replace_content
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Jeff Dickey
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: semantic_logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: minitest-tagz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+- !ruby/object:Gem::Dependency
+  name: flog
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.3.2
+- !ruby/object:Gem::Dependency
+  name: reek
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.39.0
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: pry-doc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.7.7
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.5'
+description: 
+email:
+- jdickey@seven-sigma.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".codeclimate.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/install-pandoc-from-cabal
+- bin/setup
+- config.reek
+- lib/prolog/services/replace_content.rb
+- lib/prolog/services/replace_content/splitter/factory.rb
+- lib/prolog/services/replace_content/splitter/paired.rb
+- lib/prolog/services/replace_content/splitter/paired_params.rb
+- lib/prolog/services/replace_content/splitter/splitter_params.rb
+- lib/prolog/services/replace_content/splitter/symmetric.rb
+- lib/prolog/services/replace_content/splitter/symmetric_params.rb
+- lib/prolog/services/replace_content/version.rb
+- log/.keep
+- prolog-services-replace_content.gemspec
+homepage: https://github.com/TheProlog/prolog-services-replace_content
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.3
+signing_key: 
+specification_version: 4
+summary: Replaces HTML within a specified range with HTML replacement content.
+test_files: []
+has_rdoc: