fratterhorn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0f21216812a16bac3b42fa9aedaa777a0db2bf730da484f060fa0653b1c5383c
+  data.tar.gz: 6eb2344da35b6923576c8c8275265e858ab79faebfac14aa91410ae2bbb53839
+SHA512:
+  metadata.gz: 7733dc04f13edbf37f36e6712805e9ebce7844f0fa749ae1ef72c6548f092745fd9bb6c60bb2430990736fb1678aa5d2fce38f07317aa486177802ac20c4ace9
+  data.tar.gz: 4dc8bce44a1a9591d1c9d3c3a86d9a9f3ac634c747fdd0ebb9d3df8e34282f0096d8d4d42d748f87be7e759ad82c754318c0bdb53e8c29e64c91eb26630d6c4d

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.ruby-version

@@ -0,0 +1 @@
+2.6.0

data/.travis.yml

@@ -0,0 +1,9 @@
+---
+notifications:
+  on_success: never
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.0
+before_install: gem install bundler -v 1.17.2

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in fratterhorn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    fratterhorn (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  fratterhorn!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.17.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Yusuke Nakamura
+
+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,63 @@
+# Fratterhorn
+[![Build Status](https://travis-ci.org/unasuke/fratterhorn.svg?branch=master)](https://travis-ci.org/unasuke/fratterhorn)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/bcdf94958d43f2edf4ab/test_coverage)](https://codeclimate.com/github/unasuke/fratterhorn/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/bcdf94958d43f2edf4ab/maintainability)](https://codeclimate.com/github/unasuke/fratterhorn/maintainability)
+
+Fratterhorn is simple frontmatter parser gem. The origin of the name is **fr**ontmatter and M**atterhorn**
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fratterhorn'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fratterhorn
+
+## Usage
+
+```ruby
+markdown = <<MD
+---
+title: 'how to use fratterhorn'
+date: 2018-01-31 21:00 JST
+tags:
+- ruby
+- gem
+- howto
+- programming
+---
+
+## What is fratterhorn?
+- a gem
+- parse frontmatter
+MD
+
+
+Fratterhorn.parse(markdown)
+# => { title: 'how to use fratterhorn', date: '2018-01-31 21:00 JST', tags: ['ruby', 'gem', 'howto', 'programming'] }
+
+Fratterhorn.parse(markdown, option: { guess: true }) # :date value is instance of a Time class
+# => { title: 'how to use fratterhorn', date: 2018-01-31 21:00 JST, tags: ['ruby', 'gem', 'howto', 'programming'] }
+```
+
+## 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 `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]/fratterhorn.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -0,0 +1,39 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "fratterhorn/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "fratterhorn"
+  spec.version       = Fratterhorn::VERSION
+  spec.authors       = ["Yusuke Nakamura"]
+  spec.email         = ["yusuke1994525@gmail.com"]
+
+  spec.summary       = %q{simple frontmatter parser}
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/unasuke/fratterhorn'
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+    # TODO: spec.metadata["changelog_uri"]
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # 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"]
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/fratterhorn/parse.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+require 'time'
+require 'yaml'
+
+module Fratterhorn
+  FRONTMATTER_PATTERN = %r[^---+\n*$(.*\n)*^---+\n$]
+
+  def self.parse(text, option: {})
+    @text = text
+    @option = option
+    @raw_frontmatter = ''
+
+    @raw_frontmatter = get_frontmatter
+    @frontmatter = YAML.safe_load(@raw_frontmatter).transform_keys!(&:to_sym)
+    guess_value_type if @option.dig(:guess)
+
+    @frontmatter
+  end
+
+  private
+
+  def self.get_frontmatter
+    FRONTMATTER_PATTERN.match(@text).to_a.first
+  end
+  private_class_method :get_frontmatter
+
+  def self.guess_value_type
+    @frontmatter.each do |key, value|
+      case key
+      when :date, :time, :datetime
+        @frontmatter[key] = Time.parse(value)
+      end
+    end
+  end
+  private_class_method :guess_value_type
+end

data/lib/fratterhorn/version.rb

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

data/lib/fratterhorn.rb

@@ -0,0 +1,7 @@
+require "fratterhorn/version"
+require 'fratterhorn/parse'
+
+module Fratterhorn
+  class Error < StandardError; end
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: fratterhorn
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !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'
+description: simple frontmatter parser
+email:
+- yusuke1994525@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- fratterhorn.gemspec
+- lib/fratterhorn.rb
+- lib/fratterhorn/parse.rb
+- lib/fratterhorn/version.rb
+homepage: https://github.com/unasuke/fratterhorn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/unasuke/fratterhorn
+  source_code_uri: https://github.com/unasuke/fratterhorn
+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: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: simple frontmatter parser
+test_files: []