jekyll-ipa 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b901e41698780e58c2c89e72061b4736073ea6b3cbaeacce791b7e953df052fc
+  data.tar.gz: d718d2a3b36bde1f124967347e42a7e4273a232ccabba62659ac9ca7919667c8
+SHA512:
+  metadata.gz: 598c9107f9e6f85d603e4b876390c3e9abe0f962d79d02d10ffab098ddeaa6063b09cc9cfe2cfa46f6e198c26258870a395728777697704bc0d38682c4e4905d
+  data.tar.gz: a7c0ca86b635351fd55315188092a14812796a12bc2a846a50eb5a4a321deaa49f213482278b8853cf10635e8319e13a9f64b8886c7f896505e1a6afb61f6b36

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in jekyll-ipa.gemspec
+gemspec
+
+gem "rake", "~> 13.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 pomeloshark
+
+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,48 @@
+# Jekyll::Ipa
+
+All this gem does is surround your International Phonetic Alphabet text with the following:
+
+```html
+<abbr title="International Phonetic Alphabet">IPA</abbr>: <span class="ipa">[your input here]</span>
+```
+
+and give it a little bit of styling to offset it from the surrounding text. This plugin is meant for use with the PaperWiki Jekyll theme.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'jekyll-ipa'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install jekyll-ipa
+
+## Usage
+
+```
+{% ipa [phonetic transcription here] %}
+{% ipa /phonemic transcription here/ %}
+```
+
+It is not necessary to surround the transcription in quotes.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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 the created tag, 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]/jekyll-ipa.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+task default: %i[]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "jekyll/ipa"
+
+# 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/lib/jekyll/ipa/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Jekyll
+  module Ipa
+    VERSION = "0.1.0"
+  end
+end

data/lib/jekyll/ipa.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "ipa/version"
+
+module Jekyll
+   module Tags
+      class RenderPhoneticTag < Liquid::Tag
+
+         # initialize is called when we encounter the {% ipa %} Liquid tag; 'ipa' is the tag name and anything immediately after it is passed in via the second argument
+         def initialize(tag_name, text, tokens)
+            super
+            @text = text
+         end
+
+         def render(context)
+            "<abbr class=\"gloss\" title=\"International Phonetic Alphabet\">IPA</abbr>: <span class=\"ipa\">#{@text}</span>"
+         end
+
+      end
+   end
+end
+
+# The register_tag method takes two arguments: the user-facing name of the tag [ipa], and the class that implements it [RenderPhoneticTag].
+Liquid::Template.register_tag("ipa", Jekyll::Tags::RenderPhoneticTag)

data/sig/jekyll/ipa.rbs

@@ -0,0 +1,6 @@
+module Jekyll
+  module Ipa
+    VERSION: String
+    # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: jekyll-ipa
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- pomeloshark
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-01-07 00:00:00.000000000 Z
+dependencies: []
+description:
+email:
+- 121037935+pomeloshark@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/jekyll/ipa.rb
+- lib/jekyll/ipa/version.rb
+- sig/jekyll/ipa.rbs
+homepage: https://github.com/pomeloshark/jekyll-ipa
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pomeloshark/jekyll-ipa
+  source_code_uri: https://github.com/pomeloshark/jekyll-ipa
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.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: IPA plugin to go with the Jekyll PaperWiki theme.
+test_files: []