JotBook 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4308ce617d91663fe2e22e7f148af4b95b9a0a9aa19201c7f754dc2d0795fd54
+  data.tar.gz: 316689cdb6db73f5a268336bc28e25c7f3e8a50b0782b4c9695c370a51e0cb57
+SHA512:
+  metadata.gz: ba374f5f7d1d720125be76139d39be008f330cb39e0a80341b7e5721968a1f08bb754d5cec60a6f753b2d6c3b095e4f20f7c0536e64eb2a245e8ee9435b462c3
+  data.tar.gz: e168e9c02c5a502364fdd956e059c119afc9477b0c1d095e9066c91ab2720b27e00681bb0d2ac023bec85e8fc512d8b68beb1fa61ee61f80688233257b295321

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-03-15
+
+- Initial release

data/JotBook.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/JotBook/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "JotBook"
+  spec.version = JotBook::VERSION
+  spec.authors = ["HamidrezaSafari"]
+  spec.email = ["HamidrezaSafari@hotmail.com"]
+
+  spec.summary = "Write a short summary, because RubyGems requires one."
+  spec.description = "Write a longer description or delete this line."
+  spec.homepage = "https://github.com/HamidrezaSafari/JotBook"
+  spec.required_ruby_version = ">= 3.0.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/HamidrezaSafari/JotBook"
+  spec.metadata["changelog_uri"] = "https://github.com/HamidrezaSafari/JotBook"
+  spec.license = "MIT"
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.default_executable = 'jotbook'
+  spec.require_paths = ["lib"]
+
+
+
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (C) 2012-present Dan Allen, Sarah White, Ryan Waldron, and the
+individual contributors to Asciidoctor.
+
+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,35 @@
+# JotBook
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/JotBook`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## 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]/JotBook. 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]/JotBook/blob/main/CODE_OF_CONDUCT.md).
+
+## Code of Conduct
+
+Everyone interacting in the JotBook project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/JotBook/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/lib/JotBook/generator.rb

@@ -0,0 +1,4 @@
+module JotBook
+  class Generator < Plugin
+  end
+end

data/lib/JotBook/jot.rb

@@ -0,0 +1,31 @@
+require 'date'
+
+module JotBook
+  class Jot
+    MATCHER = /^(\d+-\d+-\d+)-jot-(.*)\.([^.]+)$/
+
+    attr_accessor :date, :slug, :ext,:base,:name
+
+    def self.valid?(name)
+      name =~ MATCHER
+    end
+
+    def initialize(base, name)
+      @base = base
+      @name = name
+
+      self.process(name)
+    end
+
+    def url
+      self.date + self.slug
+    end
+
+    def process(name)
+      m, date, slug, ext = *name.match(MATCHER)
+      self.date = DateTime.parse(date).strftime("%Y-%m-%d")
+      self.slug = slug
+      self.ext = ext
+    end
+  end
+end

data/lib/JotBook/plugin.rb

@@ -0,0 +1,41 @@
+module JotBook
+  class Plugin
+    PRIORITIES = { :lowest => -100,
+                   :low => -10,
+                   :normal => 0,
+                   :high => 10,
+                   :highest => 100 }
+
+    def self.subclasses
+      @subclasses ||= []
+    end
+
+    def self.inherited(base)
+      subclasses << base
+      subclasses.sort!
+    end
+
+    def self.priority(priority = nil)
+      @priority ||= nil
+      if priority && PRIORITIES.has_key?(priority)
+        @priority = priority
+      end
+      @priority || :normal
+    end
+
+    def self.safe(safe = nil)
+      if safe
+        @safe = safe
+      end
+      @safe || false
+    end
+
+    def self.<=>(other)
+      PRIORITIES[other.priority] <=> PRIORITIES[self.priority]
+    end
+
+    def initialize(config = {})
+      # no-op for default
+    end
+  end
+end

data/lib/JotBook/site.rb

@@ -0,0 +1,53 @@
+
+module JotBook
+  class Site
+    attr_accessor :source, :dest
+    attr_accessor :layouts, :jotes
+    attr_accessor :config
+    attr_accessor :generators
+
+    def initialize(config)
+      self.config = config
+      @source = config[:source]
+      @dest = config[:destination]
+      @plugins = config[:plugins]
+      @layouts = config[:layouts]
+
+      self.jotes = []
+
+      process
+    end
+
+    def process
+      self.read_jotes
+      self.setup
+      self.generate
+    end
+
+    def setup
+       Dir[File.join(@plugins, "*.rb")].each do |plugin|
+        require plugin
+      end
+      @generators = Generator.subclasses.map do |c|
+        c.new(self.config,self.jotes)
+      end
+    end
+
+    def generate
+      @generators.each do |generator|
+        generator.generate
+      end
+    end
+
+    def read_jotes
+      base = File.join(@source)
+      entries = Dir.entries(base)
+      entries = entries.reject { |e| File.directory?(e)}
+      entries.each do |f|
+        if Jot.valid?(f)
+          self.jotes << Jot.new(base, f)
+        end
+      end
+    end
+  end
+end

data/lib/JotBook/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module JotBook
+  VERSION = "0.0.1"
+end

data/lib/JotBook.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative 'JotBook/version'
+require_relative 'JotBook/jot'
+require_relative 'JotBook/plugin'
+require_relative 'JotBook/generator'
+require_relative 'JotBook/site'
+
+module JotBook
+  class Build
+    def self.process(root_path)
+      config = {
+        source: root_path + '/_jotes',
+        destination: root_path + '/_site',
+        plugins: root_path + '/_plugins',
+        layouts: root_path + '/_layouts'
+      }
+
+      JotBook::Site.new(config)
+    end
+  end
+end

data/template/jot_plug.rb

@@ -0,0 +1,21 @@
+require 'jotdown'
+
+module JotBook
+  class JotDown < Generator
+    attr_accessor :config,:jotes
+    def initialize(config,jotes)
+      @config =  config
+      @jotes  =  jotes
+    end
+    def generate
+      @jotes.each do |jot|
+        jot_file = File.read(jot.base + '/' + jot.name)
+        result = Jotdown::Document.new(jot_file).render
+        output_file_name = "#{@config[:destination]}/#{jot.name.sub('.jd','.html')}"
+        File.open(output_file_name, 'w') do |f|
+          f.write(result)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification
+name: JotBook
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- HamidrezaSafari
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-03-15 00:00:00.000000000 Z
+dependencies: []
+description: Write a longer description or delete this line.
+email:
+- HamidrezaSafari@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- JotBook.gemspec
+- LICENSE
+- README.md
+- Rakefile
+- lib/JotBook.rb
+- lib/JotBook/generator.rb
+- lib/JotBook/jot.rb
+- lib/JotBook/plugin.rb
+- lib/JotBook/site.rb
+- lib/JotBook/version.rb
+- template/jot_plug.rb
+homepage: https://github.com/HamidrezaSafari/JotBook
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/HamidrezaSafari/JotBook
+  source_code_uri: https://github.com/HamidrezaSafari/JotBook
+  changelog_uri: https://github.com/HamidrezaSafari/JotBook
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.6
+signing_key:
+specification_version: 4
+summary: Write a short summary, because RubyGems requires one.
+test_files: []