data_files 1.0.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 38ca97e41fc75a1a3799b5647fe95a25811515d81f8d84346635f190f46d0a3b
+  data.tar.gz: 29adfa22da840b9f96d9c10631140b3dcbd9d9c4f8d82c1895873efaee56db27
+SHA512:
+  metadata.gz: 05bb9c56584c52153dbd84d95b24bb58dbeac9c2aec14237d6c3cedc20749f290c0ddfc0a097c2c14fca2ffea83aba240feaa3943e6f6daa7c02caa07b43327f
+  data.tar.gz: 3daec9182bc98e4036447bb73ed5d523b42dc9eb94cdf097df9de1e20bd1d2999cb70231bce9098e9ee6cb98b4257303ef4961b89f1559a5c7d68f693941f20d

data/.rubocop.yml

@@ -0,0 +1,2 @@
+Layout/LineLength:
+  Max: 100

data/.ruby-version

@@ -0,0 +1 @@
+2.7.0

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## [1.0.0.rc1] - 2020-01-09
+### Added
+- Initial version.

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    data_files (1.0.0.rc1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.13.0)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  data_files!
+  minitest (~> 5.0)
+  rake (~> 12.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) [2020] [Andreas Zecher]
+
+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,139 @@
+# REPL for Middleman Data Files
+
+Written during Lab Week in January 2020 at Mynewsdesk.
+
+This interactive shell allows users to manipulate [Middleman Data Files](https://middlemanapp.com/advanced/data-files/) with an API similar to ActiveRecord.
+
+## Getting Started
+
+To start the interactive shell run the following command from your Middleman project directory:
+
+```
+> rake data_files
+```
+
+## Querying data
+
+Given a file located in `data/games.yml` in a Middleman project directory, we can query our data in different ways:
+
+```ruby
+> Game.first
+#<Game title: "A Light In Chorus", url: "http://www.alightinchorus.com", year: nil, _id: 1>
+
+> Game.last
+#<Game title: "Xenon 2: Megablast", url: "http://www.bitmap-brothers.co.uk/our-games/past/xenon2.htm", year: 1989, _id: 11>
+
+> Game.find_by(title: "Another World")
+#<Game title: "Another World", url: "http://www.anotherworld.fr/anotherworld_uk/", year: 1991, _id: 4>
+  
+> Game.where(year: 1991)
+[#<Game title: "Another World", url: "http://www.anotherworld.fr/anotherworld_uk/", year: 1991, _id: 4>, #<Game title: "Commander Keen in Goodbye, Galaxy", url: "http://legacy.3drealms.com/keen4/", year: 1991, _id: 7>]
+
+> Game.all.count
+10
+```
+
+The internal `_id` attribute is ephemeral and can change between different sessions. It is not saved to the YAML file. It can however be used for querying:
+
+```ruby
+> Game.find_by(_id: 12)
+#<Game title: "Super Mario Maker 2", url: "https://www.nintendo.com/games/detail/super-mario-maker-2-switch/", year: 2019, _id: 12>
+```
+
+## Creating new data
+
+We can add new items to our data file:
+
+```ruby
+> game = Game.new(title: "Super Mario Maker 2", year: 2019, url: "https://www.nintendo.com/games/detail/super-mario-maker-2-switch/")
+#<Game title: "Super Mario Maker 2", url: "https://www.nintendo.com/games/detail/super-mario-maker-2-switch/", year: 2019, _id: nil>
+
+> game.save
+true
+
+> game
+#<Game title: "Super Mario Maker 2", url: "https://www.nintendo.com/games/detail/super-mario-maker-2-switch/", year: 2019, _id: 12>
+```
+
+## Updating data
+
+We can also update exisiting items:
+
+```ruby
+> game = Game.where(year: nil).first
+#<Game title: "A Light In Chorus", url: "http://www.alightinchorus.com", year: nil, _id: 1>
+
+> game.year = 2020
+2020
+
+> game.save
+true
+
+> game
+#<Game title: "A Light In Chorus", url: "http://www.alightinchorus.com", year: 2020, _id: 1>
+```
+
+## Normalizing data
+
+Items will ordered in the YAML file by their primary key. The first key in the array in the YAML file is considered the primary key. In our example the primary key is `title`:
+
+```yaml
+---
+- title: A Light In Chorus
+  url: http://www.alightinchorus.com
+  year: 
+```
+
+Leading and trailing whitespace is automatically removed from string attributes on `save`:
+
+```ruby
+> game = Game.new(title: " Bubble Bobble ")
+#<Game title: " Bubble Bobble ", url: nil, year: nil, _id: nil>
+
+> game.save
+true
+
+> game
+#<Game title: "Bubble Bobble", url: nil, year: nil, _id: 11>
+```
+
+## Validation
+
+Data will be automatically be validated on `save`. The validation logic is derived from the exisiting values in the YAML files.
+
+```ruby
+> list = List.new(title: nil, user: 1, slug: false, ordered: "yes", featured: "no", published_at: "today", games: "A Light In Chorus, Advanced Wars")
+#<List title: nil, user: 1, slug: false, ordered: "yes", featured: "no", published_at: "today", games: "A Light In Chorus, Advanced Wars", _id: nil>
+
+> list.save
+false
+
+> list.errors
+["title must be string", "user must be string", "slug must be string", "ordered must be false or true", "featured must be false or true", "published_at must be date", "games must be array"]
+```
+
+Here's an example for a valid `List` item. See [test/data/lists.yml](https://github.com/pixelate/data_files/blob/master/test/data/lists.yml) for the data structure that the validation logic is derived from.
+
+```ruby
+> list = List.new(title: "A list", user: "andreaszecher", slug: "a-list", ordered: true, featured: false, published_at: Date.today, games: [{title: "A Light In Chorus"}, {title: "Advanced Wars"}])
+#<List title: "A list", user: "andreaszecher", slug: "a-list", ordered: true, featured: false, published_at: 2020-01-09, games: [{:title=>"A Light In Chorus"}, {:title=>"Advanced Wars"}], _id: nil>
+> list.valid?
+true
+> list.errors
+[]
+> list.save
+true
+```
+
+Primary keys must be unique within a YAML file:
+
+```ruby
+> game = Game.new(title: 'Another World')
+#<Game title: "Another World", url: nil, year: nil, _id: nil>
+
+> game.valid?
+false
+
+> game.errors
+["Game with title Another World already exists"]
+```

data/Rakefile

@@ -0,0 +1,19 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+require_relative "lib/data_files/repl"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :"data_files" do |t|
+  unless Dir.exist?(File.join(Dir.pwd, 'data'))
+    puts 'Could not find data directory in working directory.'
+    exit
+  end
+
+  data_files = DataFiles::REPL.new(Dir.pwd)
+  data_files.prompt
+end

data/data-files.gemspec

@@ -0,0 +1,27 @@
+require_relative 'lib/data_files/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "data_files"
+  spec.version       = DataFiles::VERSION
+  spec.authors       = ["Andreas Zecher"]
+  spec.email         = ["andreas@polylists.com"]
+
+  spec.summary       = %q{REPL for Middleman Data Files}
+  spec.description   = %q{This interactive shell allows users to manipulate Middleman Data Files with an API similar to ActiveRecord.}
+  spec.homepage      = "https://github.com/pixelate/data-files"
+  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/pixelate/data-files"
+  spec.metadata["changelog_uri"] = "https://github.com/pixelate/data-files/blob/master/CHANGELOG.md"
+
+  # 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/data/games.yml

@@ -0,0 +1,31 @@
+---
+- title: A Light In Chorus
+  url: http://www.alightinchorus.com
+  year: 
+- title: Advance Wars
+  url: https://www.nintendo.co.jp/n08/bgwj/index.html
+  year: 2001
+- title: 'Animal Crossing: New Leaf'
+  url: http://animal-crossing.com/newleaf/
+  year: 2012
+- title: Another World
+  url: http://www.anotherworld.fr/anotherworld_uk/
+  year: 1991
+- title: BOXBOY!
+  url: https://www.hallab.co.jp/eng/works/detail/002704/
+  year: 2015
+- title: Commander Keen in Goodbye, Galaxy
+  url: http://legacy.3drealms.com/keen4/
+  year: 1991
+- title: Donut County
+  url: http://www.donutcounty.com/
+  year: 2018
+- title: Firewatch
+  url: http://www.firewatchgame.com
+  year: 2016
+- title: wipE'out
+  url: 
+  year: 1995
+- title: 'Xenon 2: Megablast'
+  url: http://www.bitmap-brothers.co.uk/our-games/past/xenon2.htm
+  year: 1989

data/data/lists.yml

@@ -0,0 +1,18 @@
+---
+- title: A list
+  user: andreaszecher
+  slug: a-list
+  ordered: true
+  featured: false
+  published_at: 2020-01-08
+  games:
+  - title: A Light In Chorus
+  - title: Advance Wars
+  - title: Another World
+  - title: 'Animal Crossing: New Leaf'
+  - title: BOXBOY!
+  - title: Commander Keen in Goodbye, Galaxy
+  - title: Donut County
+  - title: Firewatch
+  - title: wipE'out
+  - title: 'Xenon 2: Megablast'

data/lib/data_files/active_data.rb

@@ -0,0 +1,172 @@
+# frozen_string_literal: true
+
+# Base class for data querying and manipulation.
+module DataFiles
+  class ActiveData
+    attr_reader :errors
+
+    def self.all
+      data.collect do |item|
+        new(item)
+      end
+    end
+
+    def self.first
+      new(data.first)
+    end
+
+    def self.last
+      new(data.last)
+    end
+
+    def self.where(conditions)
+      all.select do |item|
+        selected = true
+        conditions.each do |key, value|
+          selected = false if item.send(key) != value
+        end
+        selected
+      end
+    end
+
+    def self.find_by(conditions)
+      results = where(conditions)
+      if results.size.positive?
+        results.first
+      else
+        nil
+      end
+    end
+
+    def self.write_yaml
+      sort_by_primary_key
+      item_attributes = all.collect(&:attributes)
+
+      File.open("data/#{name.downcase}s.yml", 'w') do |file|
+        file.write(item_attributes.to_yaml)
+      end
+    end
+
+    def self.data
+      class_variable_get(:@@data)
+    end
+
+    def self.data=(value)
+      class_variable_set(:@@data, value)
+    end
+
+    def self.attributes
+      class_variable_get(:@@attributes)
+    end
+
+    def self.types
+      class_variable_get(:@@types)
+    end
+
+    def self.sort_by_primary_key
+      self.data = data.sort_by do |item|
+        primary_key_value = item.values.first
+        if primary_key_value.is_a? String
+          primary_key_value.downcase
+        else
+          primary_key_value
+        end
+      end
+    end
+
+    def initialize(attrs = {})
+      @_id = nil
+      attrs.each { |key, value| send("#{key}=", value) }
+    end
+
+    def attributes
+      attributes_hash = {}
+      self.class.attributes.each do |attr|
+        attributes_hash[attr] = send(attr) unless attr == '_id'
+      end
+      attributes_hash
+    end
+
+    def to_s
+      joined_attributes = self.class.attributes.collect do |attr|
+        val = send(attr)
+        val = "\"#{val}\"" if val.is_a? String
+        "#{attr}: #{val.nil? ? 'nil' : val}"
+      end.join(', ')
+
+      "#<#{self.class} #{joined_attributes}>"
+    end
+
+    def inspect
+      to_s
+    end
+
+    def valid?
+      @errors = []
+
+      primary_key = self.class.attributes.first
+      primary_key_values = self.class.data.collect do |item|
+        { item['_id'] => item[primary_key] }
+      end
+
+      primary_key_values.each do |item|
+        item.each do |key, value|
+          if key != @_id && value == send(primary_key)
+            @errors << "#{self.class.name} with #{primary_key} #{send(primary_key)} already exists"
+          end
+        end
+      end
+
+      attributes.each do |key, value|
+        unless self.class.types[key].include?(value.class.name)
+          @errors << type_validation_error_message(key, self.class.types[key])
+        end
+      end
+
+      @errors.size.zero?
+    end
+
+    def save
+      return false unless valid?
+
+      strip
+
+      self.class.data = self.class.data.map do |item|
+        if item['_id'] == @_id
+          attributes.merge('_id' => @_id)
+        else
+          item
+        end
+      end
+
+      if @_id.nil?
+        @_id = next_id
+        self.class.data << attributes.merge('_id' => @_id)
+      end
+
+      self.class.write_yaml
+      true
+    end
+
+    def strip
+      self.class.attributes.each do |attr|
+        send("#{attr}=", send(attr).strip) if send(attr).is_a? String
+      end
+      self
+    end
+
+    private
+
+    def type_validation_error_message(attr, class_names)
+      allowed_types = class_names.map do |class_name|
+        class_name.gsub('Class', '').downcase
+      end
+
+      "#{attr} must be #{allowed_types.sort.join(', ')}".sub(/.*\K, /, ' or ')
+    end
+
+    def next_id
+      self.class.data.collect { |item| item['_id'] }.compact.max + 1
+    end
+  end
+end

data/lib/data_files/repl.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'date'
+require 'readline'
+require 'yaml'
+require_relative 'active_data.rb'
+
+# Loads all yaml files in given directory, creates ActiveData subclass
+# for each file and provides an interactive shell.
+module DataFiles
+  class REPL
+    def initialize(directory)
+      @klass_names = []
+      parse_data(directory)
+    end
+
+    def parse_data(directory)
+      Dir.foreach(File.join(directory, 'data')) do |filename|
+        next unless filename.end_with?('.yml')
+
+        filepath = File.join(directory, 'data', filename)
+        key = File.basename(filepath, File.extname(filepath))
+        data = load_yaml(filepath)
+
+        klass_name = key.capitalize.delete_suffix('s')
+        create_class(klass_name, data)
+      end
+    end
+
+    def create_class(klass_name, data)
+      @klass_names << klass_name
+
+      types = parse_types(data)
+      klass = Class.new(ActiveData) do
+        class_variable_set(:@@data, data)
+        class_variable_set(:@@attributes, data.first.keys)
+        class_variable_set(:@@types, types)
+        attr_accessor(*data.first.keys)
+      end
+
+      Object.const_set(klass_name, klass)
+    end
+
+    def prompt
+      initial_prompt
+      read_input
+    end
+
+    def initial_prompt
+      puts 'Available data models:'
+      @klass_names.sort.each do |klass_name|
+        puts " - #{klass_name}"
+      end
+    end
+
+    def read_input
+      bnd = binding
+      while (input = Readline.readline('> ', true))
+        begin
+          puts bnd.eval(input).to_s
+        rescue StandardError => e
+          puts "\e[31m#{e.class}:\e[0m #{e.message}"
+        end
+      end
+    end
+
+    private
+
+    def load_yaml(filepath)
+      YAML
+        .safe_load(File.read(filepath), permitted_classes: [Date])
+        .map
+        .each_with_index { |item, index| item.merge('_id' => index + 1) }
+    end
+
+    def parse_types(data)
+      types = {}
+      data.first.keys.each do |attr|
+        types[attr] = data.collect { |item| item[attr].class.name }
+        types[attr] << 'TrueClass' if types[attr].include?('FalseClass')
+        types[attr] << 'FalseClass' if types[attr].include?('TrueClass')
+        types[attr].uniq!
+      end
+      types
+    end
+  end
+end

data/lib/data_files/version.rb

@@ -0,0 +1,3 @@
+module DataFiles
+  VERSION = "1.0.0.rc1"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: data_files
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc1
+platform: ruby
+authors:
+- Andreas Zecher
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-01-09 00:00:00.000000000 Z
+dependencies: []
+description: This interactive shell allows users to manipulate Middleman Data Files
+  with an API similar to ActiveRecord.
+email:
+- andreas@polylists.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- data-files.gemspec
+- data/games.yml
+- data/lists.yml
+- lib/data_files/active_data.rb
+- lib/data_files/repl.rb
+- lib/data_files/version.rb
+homepage: https://github.com/pixelate/data-files
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/pixelate/data-files
+  source_code_uri: https://github.com/pixelate/data-files
+  changelog_uri: https://github.com/pixelate/data-files/blob/master/CHANGELOG.md
+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: 1.3.1
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: REPL for Middleman Data Files
+test_files: []