jfm 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b721f4a0a9bc23114c21f203534db59521668bb3bfb47e8b474d3fdf4832165
+  data.tar.gz: 3b725575cfc7452f59a18f2cd3e95ebd53bd26e726622a5a1777a014b0317a98
+SHA512:
+  metadata.gz: a3f5503d0ed1f9c531c92e50753ea5b5fb1282bae0c69b4e04840aeb0177ed63c52651538a2f0786a705564d35f3cf33274c81677169d66432afcf7a31c23cf0
+  data.tar.gz: b98de54f463f694a31f5e230fb902ddacc5cb0ba84967268faa0d4522a8f030dc59821f41a126786fd1654895824ebd80c219b5465670b9168193150725f4485

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.1
+before_install: gem install bundler -v 2.1.4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at rob@bigfish.co.uk. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jfm.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    jfm (0.1.0)
+      dry-cli (~> 0.6.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    concurrent-ruby (1.1.7)
+    diff-lcs (1.4.4)
+    dry-cli (0.6.0)
+      concurrent-ruby (~> 1.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.0)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  jfm!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Rob Miller
+
+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,101 @@
+# jfm
+
+`jfm` is a tool for interacting with Jekyll frontmatter from the command
+line.
+
+In Jekyll, all posts have “frontmatter” at the start of them, that
+define certain things about the post:
+
+```
+---
+layout: post
+title: A lovely post
+---
+
+Here’s a lovely post
+```
+
+The frontmatter is the bit between the `---` and the `---`.
+
+This tool allows you to search for posts based on their frontmatter, and
+then manipulate that frontmatter in certain ways. Basically, it makes
+doing find-and-replace on Jekyll frontmatter a lot easier.
+
+## Installation
+
+    $ gem install jfm
+
+## Usage
+
+`jfm` offers two commands: `find` and `edit`.
+
+### Finding posts
+
+`find` finds posts that match the given queries. For example, given
+a site with only the example post given above, you could find that post
+in the following ways:
+
+```
+$ jfm find "layout"
+_posts/2020-12-02-lovely-post.markdown
+
+$ jfm find "layout: post"
+_posts/2020-12-02-lovely-post.markdown
+
+$ jfm find "layout: ~page"
+_posts/2020-12-02-lovely-post.markdown
+
+$ jfm find "title: A lovely post"
+_posts/2020-12-02-lovely-post.markdown
+
+$ jfm find "title: A lovely post" "layout: post"
+_posts/2020-12-02-lovely-post.markdown
+```
+
+In short:
+
+* a query of `foo` will match posts that have a variable called `foo`
+  regardless of its value
+* a query of `foo: bar` will match posts that have a variable called
+  `foo` set to the value `bar`
+* a query of `foo: ~bar` will match posts that have a variable called
+  `foo` that is set to any value *other* than `bar`
+* you can pass multiple queries; `find` will return posts that match
+  them all
+
+### Editing frontmatter
+
+`edit` edits the frontmatter to set a given value. For example, to set
+the layout of every single post to “page”, you could:
+
+```
+$ ls _posts/* | jfm edit "layout: page"
+```
+
+This pairs well with the `find` command to only edit certain posts:
+
+```
+$ jfm find "layout: post" | jfm edit "layout: page"
+```
+
+If a variable with that name already exists, it will be replaced; if it
+doesn’t exist, it will be created.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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 `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec 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).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/jfm. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/jfm/blob/master/CODE_OF_CONDUCT.md).
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Jfm project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/jfm/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jfm"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/jfm

@@ -0,0 +1,89 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+
+require "dry/cli"
+
+require "jfm"
+
+module Jfm
+  module CLI
+    class Command < Dry::CLI::Command
+      def self.inherited(klass)
+        super
+
+        klass.option :dir, aliases: ["-d"], default: ".", desc: "Path to your Jekyll directory. Assumes the current directory."
+      end
+    end
+
+    module Commands
+      extend Dry::CLI::Registry
+
+      class Version < Jfm::CLI::Command
+        desc "Print version"
+
+        def call(*)
+          puts Jfm::VERSION
+        end
+      end
+
+      class Find < Jfm::CLI::Command
+        desc "Search for files with specific frontmatter. Outputs a list of filenames."
+
+        argument :queries, type: :array, required: true, desc: "Query/queries to match"
+
+        example [
+          %q("layout"         # Finds all posts that have a "layout" value set in their frontmatter),
+          %q("layout: post"   # Finds all posts whose "layout" value is set to "post"),
+          %q("layout: ~post"  # Finds all posts whose "layout" value is *not* set to "post")
+        ]
+
+        def call(dir:, queries: [], **)
+          site = Site.new(dir)
+
+          posts = site.posts.select do |post|
+            queries.all? { |q| post.match?(q) }
+          end
+
+          posts.each do |post|
+            puts post.filename
+          end
+        end
+      end
+
+      class Edit < Jfm::CLI::Command
+        desc "Edit the frontmatter for a set of files"
+
+        argument :values, type: :array, require: true, desc: "Values to add/edit"
+
+        example [
+          %q("foo: bar"    # Sets the value of the "foo" post variable to "bar")
+        ]
+
+        def call(dir:, values: [], **)
+          posts = $stdin.each_line.map(&:chomp).map { |f| Post.new(f) }
+          if posts.empty?
+            warn "No files specified"
+            abort
+          end
+
+          posts.each do |post|
+            frontmatter = post.frontmatter
+            values.each do |value|
+              key, value = value.split(":").map(&:strip)
+              frontmatter[key] = value
+            end
+            post.frontmatter = frontmatter
+            post.save
+          end
+        end
+      end
+
+      register "version", Version, aliases: ["v", "-v", "--version"]
+      register "find",    Find,    aliases: ["f"]
+      register "edit",    Edit,    aliases: ["e"]
+    end
+  end
+end
+
+Dry::CLI.new(Jfm::CLI::Commands).call

data/jfm.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/jfm/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jfm"
+  spec.version       = Jfm::VERSION
+  spec.authors       = ["Rob Miller"]
+  spec.email         = ["r@robm.me.uk"]
+
+  spec.summary       = "A command-line tool for working with Jekyll frontmatter."
+  spec.homepage      = "https://github.com/robmiller/jfm"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/robmiller/jfm"
+
+  spec.add_runtime_dependency "dry-cli", "~> 0.6.0"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/jfm.rb

@@ -0,0 +1,70 @@
+require "pathname"
+require "yaml"
+
+require "jfm/version"
+
+module Jfm
+  class Error < StandardError; end
+
+  class Site
+    def initialize(dir)
+      @working_dir = Pathname(dir)
+    end
+
+    def posts
+      post_files.map { |file| Post.new(file) }
+    end
+
+    private
+
+    def post_files
+      Dir[@working_dir + "_posts" + "*"]
+    end
+  end
+
+  class Post
+    attr_reader :filename
+
+    def initialize(filename)
+      @filename = filename
+    end
+
+    def frontmatter
+      @frontmatter ||= YAML.load(raw_frontmatter)
+    end
+
+    def frontmatter=(new_frontmatter)
+      @frontmatter = new_frontmatter
+    end
+
+    def match?(query)
+      case query
+      when /(.+?):\s*~(.+)/
+        frontmatter[$1] != $2
+      when /(.+?):\s*(.+)/
+        frontmatter[$1] == $2
+      else
+        frontmatter.has_key?(query)
+      end
+    end
+
+    def save
+      backmatter = content.lines.drop_while { |l| l.chomp == "---" }.drop_while { |l| l.chomp != "---" }.drop(1).join
+      File.open(filename, "w") do |file|
+        file.write YAML::dump(frontmatter)
+        file.puts "---"
+        file.write backmatter
+      end
+    end
+
+    private
+
+    def content
+      @content ||= File.read(filename)
+    end
+
+    def raw_frontmatter
+      content.lines.drop_while { |l| l.chomp == "---" }.take_while { |l| l.chomp != "---" }.join
+    end
+  end
+end

data/lib/jfm/version.rb

@@ -0,0 +1,3 @@
+module Jfm
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: jfm
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rob Miller
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2020-12-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dry-cli
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.0
+description:
+email:
+- r@robm.me.uk
+executables:
+- jfm
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/jfm
+- jfm.gemspec
+- lib/jfm.rb
+- lib/jfm/version.rb
+homepage: https://github.com/robmiller/jfm
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/robmiller/jfm
+  source_code_uri: https://github.com/robmiller/jfm
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: A command-line tool for working with Jekyll frontmatter.
+test_files: []