yarii-content-model 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1077ab034fdf4c9d1bb0e81e441034573a48fa2c1c1907dfcc23123db48375f2
-  data.tar.gz: 61203f7d66445dda0765b88b23c370bd839749f60ae0037d2da8527604527102
+  metadata.gz: e14fc98612d9fbb29d8fae96d8a006ffaa8fde3e963280a4febaa116bd1cd031
+  data.tar.gz: c49b39d476a5495c57d624c18723491ba8ba5797578ac227e98a69e8ecdc294e
 SHA512:
-  metadata.gz: 4dacb9420563487b2fbe64ec773c9bddbf6c63f63063b29a3e91ca01b3ce4df10b8773fe59d19a056f938c0b242d6cfcac703fe989a530357436256c23897ade
-  data.tar.gz: 6b2f4a08a63c756d68d6b929e237ff38413b1bcaa6dd15045870346458a57b509dbbf703d6b4d330efec497a15928a979914ddb4c70575d9f094dd2c21429b3c
+  metadata.gz: 376f680ef0f239f21d50f0b3f55c743e61b591d586eedaaff2e133c58bef844f7b34802818944eb16659f796c93036ee26ade1f349eafb67581f8e14609b3628
+  data.tar.gz: 6db67e209966477c0f07f973bdd0c0f6a5097511696d93e213cb086430fd42411eecc0f937d82de5bc2b0a20834513d113eb7878e0ee1b17edf354276f517d6c

data/.gitignore

@@ -0,0 +1,10 @@
+Gemfile.lock
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/db/*.sqlite3-journal
+test/dummy/log/*.log
+test/dummy/tmp/
+test/tmp/
+.ruby-version

data/Gemfile

@@ -0,0 +1,14 @@
+source 'https://rubygems.org'
+
+# Declare your gem's dependencies in yarii_platform.gemspec.
+# Bundler will treat runtime dependencies like base dependencies, and
+# development dependencies will be added by default to the :development group.
+gemspec
+
+# Declare any dependencies that are still in development here instead of in
+# your gemspec. These might include edge Rails or gems from your path or
+# Git. Remember to move these dependencies to your gemspec before releasing
+# your gem to rubygems.org.
+
+# To use a debugger
+# gem 'byebug', group: [:development, :test]

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Whitefusion
+
+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,9 @@
+# Yarii::ContentModel
+
+Provides an ActiveRecord-like method of loading and saving static content files (from Jekyll, Hugo, etc.)
+
+Extracted and enhanced based on running production code.
+
+Brought to you by [Whitefusion](https://whitefusion.io)
+
+(Still WIP — stay tuned for the official release!)

data/Rakefile

@@ -0,0 +1,38 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'YariiContentModel'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+# Disabling for now
+#APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+#load 'rails/tasks/engine.rake'
+
+
+#load 'rails/tasks/statistics.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/models/yarii/content_model.rb

@@ -0,0 +1,265 @@
+require 'safe_yaml'
+require 'fileutils'
+require 'rake'
+
+class Yarii::ContentModel
+  include ActiveModel::Model
+  extend ActiveModel::Callbacks
+  define_model_callbacks :save, :destroy
+
+  include Yarii::Serializers::YAML
+  extend Yarii::VariableDefinitions
+  extend Yarii::FilePathDefinitions
+
+  # override in ApplicationContentModel
+  class_attribute :base_path, instance_accessor: false, default: ""
+
+  # override in subclass model
+  class_attribute :folder_path, instance_accessor: false, default: ""
+
+  class_attribute :variable_names, instance_accessor: false, default: []
+
+  attr_accessor :file_path, :content
+
+  # code snippet from Jekyll
+  YAML_FRONT_MATTER_REGEXP = %r!\A(---\s*\n.*?\n?)^((---|\.\.\.)\s*$\n?)!m
+  CHECK_BASE_64_REGEXP = /^([A-Za-z0-9+\/]{4})*([A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)$/
+  PAGINATION_SIZE = 12
+
+  def self.find(file_path)
+    raise "Missing base path for the #{self.name} content model" if self.base_path.blank?
+
+    # decode Base64 path if necessary
+    if CHECK_BASE_64_REGEXP.match file_path
+      file_path = Base64::decode64 file_path
+    end
+
+    file_path = absolute_path(file_path)
+
+    new(file_path: file_path).tap do |content_model|
+      content_model.load_file_from_path
+    end
+  end
+
+  def self.absolute_path(path)
+    sanitize_filepath File.join(self.base_path, self.folder_path, path)
+  end
+
+  def self.sanitize_filepath(path)
+    if path.include? "../"
+      # TODO: output better error message ;)
+      raise "Nice try, Hacker Dude. You lose."
+    end
+
+    path
+  end
+
+  def self.all(sorted: true, order_by: :posted_datetime, order_direction: :desc, subfolder: nil)
+    raise "Missing base path for the #{self.name} content model" if self.base_path.blank?
+
+    if self.folder_path.present?
+      # find all content files in the folder and any direct subfolders
+      glob_pattern = File.join(self.base_path, self.folder_path, subfolder.to_s, "**/*.{md,markdown,html}")
+
+      files = Dir.glob(glob_pattern)
+    else
+      # find any content files not in special underscore folders
+      files = Rake::FileList.new(
+        File.join(self.base_path, "**/*.md"),
+        File.join(self.base_path, "**/*.markdown"),
+        File.join(self.base_path, "**/*.html")
+      ) do |fl|
+        basename = Pathname.new(self.base_path).basename.sub(/^_/, '')
+        fl.exclude(/#{basename}\/\_/)
+      end
+    end
+
+    models = files.map do |file_path|
+      unless File.directory? file_path
+        new(file_path: file_path).tap do |content_model|
+          content_model.load_file_from_path
+        end
+      end
+    end.compact
+
+    if sorted
+      models.sort_by! do |content_model|
+        content_model.send(order_by)
+      end
+      order_direction == :desc ? models.reverse : models
+    else
+      models
+    end
+  end
+
+  def save
+    run_callbacks :save do
+      if file_path.blank?
+        self.file_path = generate_new_file_path
+      end
+
+      # Create folders if necessary
+      dir = File.dirname(file_path)
+      unless File.directory?(dir)
+        FileUtils.mkdir_p(dir)
+      end
+
+      File.open(file_path, 'w') do |f|
+        f.write(generate_file_output)
+      end
+
+      true
+    end
+  end
+
+  def destroy
+    run_callbacks :destroy do
+      if persisted?
+        File.delete(file_path)
+        self.file_path = nil
+
+        true
+      end
+    end
+  end
+
+  def id
+    if persisted?
+      Base64.encode64(relative_path).strip
+    end
+  end
+
+  def relative_path
+    relative_base = File.join(self.class.base_path, self.class.folder_path)
+    file_path.sub(/^#{relative_base}/, '')
+  end
+
+  def persisted?
+    file_path.present? && File.exist?(file_path)
+  end
+  def new_record?
+    !persisted?
+  end
+
+  def file_name
+    file_path&.split('/')&.last
+  end
+
+  def file_stat
+    if persisted?
+      @file_stat ||= File.stat(file_path)
+    end
+  end
+
+  def posted_datetime
+    if variable_names.include?(:date) && date
+      date.to_datetime
+    elsif matched = file_name.to_s.match(/^[0-9]+-[0-9]+-[0-9]+/)
+      matched[0].to_datetime
+    elsif persisted?
+      file_stat.mtime
+    end
+  end
+
+  def will_be_published?
+    return false if respond_to?(:published) and published === false
+    return false if respond_to?(:draft) and draft
+    true
+  end
+
+  def generate_new_file_path
+    # NOTE: this can totally be subclassed by various content models…
+
+    if use_date = date && date.to_datetime
+      date_prefix = "#{use_date.strftime('%Y-%m-%d')}-"
+    else
+      date_prefix = "#{Date.current.strftime('%Y-%m-%d')}-"
+    end
+
+    slug = if title
+      title.gsub(/['|"]/,'').parameterize
+    else
+      "untitled_#{self.class.name.parameterize}"
+    end
+
+    self.class.absolute_path("#{date_prefix}#{slug}.md")
+  end
+
+  def generate_file_output
+    # NOTE: this can totally be subclassed by various content models…
+
+    as_yaml + "---\n\n" + content.to_s
+  end
+
+  def variable_names
+    @variable_names ||= self.class.variable_names&.dup || []
+  end
+
+  def attributes
+    ret = {}
+    variable_names.each do |var_name|
+      ret[var_name.to_s] = send(var_name.to_sym)
+    end
+    ret
+  end
+
+  def assign_attributes(new_attributes)
+    # Changed from Active Model
+    # (we implement our own method of assigning attributes)
+
+    if !new_attributes.respond_to?(:stringify_keys)
+      raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
+    end
+    return if new_attributes.empty?
+
+    attributes = new_attributes.stringify_keys
+    update_variables(sanitize_for_mass_assignment(attributes))
+  end
+
+  def update_variables(hash)
+    hash.each do |key, value|
+      begin
+        send("#{key}=", value)
+      rescue NoMethodError
+        Rails.logger.warn (":#{key}: is not a defined front matter variable, will be available as read-only")
+
+        # If an unfamiliar variable is present, allow it to be set as a
+        # read-only value for future serialization, but it still can't be set
+        # via an accessor writer. Kind ugly code, but it works
+        instance_variable_set("@#{key}", value)
+        unless key.to_sym.in? variable_names
+          variable_names << key.to_sym
+          define_singleton_method key.to_sym do
+            instance_variable_get("@#{key}")
+          end
+        end
+      end
+    end
+  end
+
+  def load_file_from_path
+    file_data = File.read(file_path)
+
+    loaded_variables = {}
+
+    begin
+      if file_data =~ YAML_FRONT_MATTER_REGEXP
+        self.content = $'
+        loaded_variables = ::SafeYAML.load(Regexp.last_match(1))
+      end
+    rescue SyntaxError => e
+      Rails.logger.error "Error: YAML Exception reading #{file_path}: #{e.message}"
+    end
+
+    if loaded_variables.present?
+      update_variables(loaded_variables)
+    end
+  end
+
+
+  def as_json(options={})
+    options[:except] = (options[:except] || []) + ["variable_names"]
+    super(options)
+  end
+
+end

data/app/models/yarii/datafile_model.rb

@@ -0,0 +1,255 @@
+require 'safe_yaml'
+require 'fileutils'
+require 'rake'
+
+class Yarii::DatafileModel
+  include ActiveModel::Model
+  extend ActiveModel::Callbacks
+  define_model_callbacks :save, :destroy
+
+  include Yarii::Serializers::YAML
+  extend Yarii::VariableDefinitions
+  extend Yarii::FilePathDefinitions
+
+  # override in ApplicationContentModel
+  class_attribute :base_path, instance_accessor: false, default: ""
+
+  # override in subclass model
+  class_attribute :folder_path, instance_accessor: false, default: ""
+
+  class_attribute :variable_names, instance_accessor: false, default: []
+
+  attr_accessor :file_path, :key_path
+
+  # code snippet from Jekyll
+  CHECK_BASE_64_REGEXP = /^([A-Za-z0-9+\/]{4})*([A-Za-z0-9+\/]{4}|[A-Za-z0-9+\/]{3}=|[A-Za-z0-9+\/]{2}==)$/
+  PAGINATION_SIZE = 12
+
+  def self.find(file_path, key_path)
+    raise "Missing base path for the #{self.name} content model" if self.base_path.blank?
+
+    # decode Base64 path if necessary
+    if CHECK_BASE_64_REGEXP.match file_path
+      file_path = Base64::decode64 file_path
+    end
+
+    file_path = absolute_path(file_path)
+
+    new(file_path: file_path, key_path: key_path).tap do |content_model|
+      content_model.load_file_from_path
+    end
+  end
+
+  def self.absolute_path(path)
+    sanitize_filepath File.join(self.base_path, self.folder_path, path)
+  end
+
+  def self.sanitize_filepath(path)
+    if path.include? "../"
+      # TODO: output better error message ;)
+      raise "Nice try, Hacker Dude. You lose."
+    end
+
+    path
+  end
+
+  def self.all(file_path)
+    raise "Missing base path for the #{self.name} content model" if self.base_path.blank?
+  
+    if CHECK_BASE_64_REGEXP.match file_path
+      file_path = Base64::decode64 file_path
+    end
+
+    file_path = absolute_path(file_path)
+
+    file_data = File.read(file_path)
+
+    loaded_variables = {}
+
+    yaml_data = nil
+
+    begin
+      yaml_data = ::SafeYAML.load(file_data)
+    end
+
+    if yaml_data.nil?
+      raise "YAML wasn't loadable"
+    end
+
+    models = []
+
+    if yaml_data.is_a? Array
+      yaml_data.each_with_index do |item, index|
+        models << new(file_path: file_path, key_path: index.to_s).tap do |content_model|
+          content_model.load_file_from_path
+        end
+      end
+    else
+      yaml_data = ActiveSupport::HashWithIndifferentAccess.new(yaml_data)
+      yaml_data.keys.each do |key|
+        models << new(file_path: file_path, key_path: key.to_s).tap do |content_model|
+          content_model.load_file_from_path
+        end
+      end
+    end
+
+    models
+  end
+
+  def save
+    run_callbacks :save do
+      if file_path.blank?
+        raise "Must supply a file path to save to"
+      end
+
+      file_data = File.read(file_path)
+
+      loaded_variables = {}
+  
+      yaml_data = nil
+
+      begin
+        yaml_data = ::SafeYAML.load(file_data)
+      end
+
+      if yaml_data.nil?
+        raise "YAML wasn't loadable"
+      end
+
+      final_data = nil
+
+      if yaml_data.is_a? Array
+        yaml_data.set_keypath(key_path, as_yaml(as_hash: true))
+        final_data = yaml_data.to_yaml
+      else
+        yaml_data = ActiveSupport::HashWithIndifferentAccess.new(yaml_data)
+        yaml_data.set_keypath(key_path, as_yaml(as_hash: true))
+        final_data = yaml_data.to_hash.to_yaml
+      end
+
+      final_data.sub!(/^---$\n/,'') # strip off the leading dashes
+
+      File.open(file_path, 'w') do |f|
+        f.write(final_data)
+      end
+
+      # TODO: figure out a better way to hook in repo updates
+  #    Yarii::Repository.current&.add(file_path_to_use)
+
+      true
+    end
+  end
+
+  def destroy
+    # TODO: what does it mean to destroy a keypath?
+    raise "TBD"
+    run_callbacks :destroy do
+      if persisted?
+        File.delete(file_path)
+      # TODO: figure out a better way to hook in repo updates
+  #      Yarii::Repository.current&.remove(file_path)
+        self.file_path = nil
+
+        true
+      end
+    end
+  end
+
+  def id
+    if persisted?
+      relative_base = File.join(self.class.base_path, self.class.folder_path)
+      relative_path = file_path.sub(/^#{relative_base}/, '')
+      Base64.encode64(relative_path).strip
+    end
+  end
+
+  def persisted?
+    file_path.present? && File.exist?(file_path)
+  end
+  def new_record?
+    !persisted?
+  end
+
+  def file_name
+    file_path&.split('/')&.last
+  end
+
+  def file_stat
+    if persisted?
+      @file_stat ||= File.stat(file_path)
+    end
+  end
+
+  def posted_datetime
+    if variable_names.include?(:date) && date
+      date.to_datetime
+    elsif persisted?
+      file_stat.mtime
+    end
+  end
+
+  def variable_names
+    @variable_names ||= self.class.variable_names&.dup || []
+  end
+
+  def attributes
+    ret = {}
+    variable_names.each do |var_name|
+      ret[var_name.to_s] = nil
+    end
+    ret
+  end
+
+  def assign_attributes(new_attributes)
+    # Changed from Active Model
+    # (we implement our own method of assigning attributes)
+
+    if !new_attributes.respond_to?(:stringify_keys)
+      raise ArgumentError, "When assigning attributes, you must pass a hash as an argument."
+    end
+    return if new_attributes.empty?
+
+    attributes = new_attributes.stringify_keys
+    update_variables(sanitize_for_mass_assignment(attributes))
+  end
+
+  def update_variables(hash)
+    hash.each do |key, value|
+      begin
+        send("#{key}=", value)
+      rescue NoMethodError
+        Rails.logger.warn (":#{key}: is not a defined front matter variable, will be available as read-only")
+
+        # If an unfamiliar variable is present, allow it to be set as a
+        # read-only value for future serialization, but it still can't be set
+        # via an accessor writer. Kind ugly code, but it works
+        instance_variable_set("@#{key}", value)
+        unless key.to_sym.in? variable_names
+          variable_names << key.to_sym
+          define_singleton_method key.to_sym do
+            instance_variable_get("@#{key}")
+          end
+        end
+      end
+    end
+  end
+
+  def load_file_from_path
+    raise "Missing keypath" if key_path.nil?
+    file_data = File.read(file_path)
+
+    loaded_variables = {}
+
+    begin
+      yaml_data = ::SafeYAML.load(file_data)
+      loaded_variables = yaml_data.value_at_keypath(key_path)
+    rescue SyntaxError => e
+      Rails.logger.error "Error: YAML Exception reading #{file_path}: #{e.message}"
+    end
+
+    if loaded_variables.present?
+      update_variables(loaded_variables)
+    end
+  end
+
+end

data/lib/yarii-content-model/version.rb

@@ -1,3 +1,3 @@
 module YariiContentModel
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/yarii-content-model.gemspec

@@ -0,0 +1,25 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "yarii-content-model/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "yarii-content-model"
+  s.version     = YariiContentModel::VERSION
+  s.authors     = ["Jared White"]
+  s.email       = ["jared@jaredwhite.com"]
+  s.homepage    = "https://whitefusion.io"
+  s.summary     = "Provides an ActiveRecord-like method of loading and saving static content files (from Bridgetown, Jekyll, etc.)"
+  s.description = s.summary
+  s.license     = "MIT"
+
+  s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r!^(test|script|spec|features)/!) }
+
+  s.add_dependency "rails", ">= 5.0", "< 7.0"
+  s.add_dependency 'safe_yaml', '~> 1.0'
+  s.add_dependency 'key_path', '~> 1.2'
+  s.add_dependency 'git', '~> 1.3'
+
+  s.add_development_dependency "rspec-rails", "3.8.2"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yarii-content-model
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Jared White
@@ -94,11 +94,19 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- app/models/yarii/content_model.rb
+- app/models/yarii/datafile_model.rb
 - lib/content_model_mixins.rb
 - lib/tasks/yarii_content_model_tasks.rake
 - lib/yarii-content-model.rb
 - lib/yarii-content-model/engine.rb
 - lib/yarii-content-model/version.rb
+- yarii-content-model.gemspec
 homepage: https://whitefusion.io
 licenses:
 - MIT