knish 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9cebed317cbe29913edc52b2b410aac9b62033a3
+  data.tar.gz: bf914734271075a48d16cd03c9be1342418fd8d6
+SHA512:
+  metadata.gz: 644bd7a99649f92ceed6d6cd12dbfe97f60583454ceb947650bf3d5ee736fe219c15cdaac30956109879d08ad0bbd22a54f953d6ecccde60ff6ec8bd6908cf34
+  data.tar.gz: 3be97cd34a43e957c176c3faac8670919791ea0a9378e11de2961851a90c0adc18d31602e2b400d3ac09a538e38a045bfddf094591ab7a42b94edbac006ec937

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in knish.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Kane Baccigalupi
+
+MIT License
+
+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,29 @@
+# Knish
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knish'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knish
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/knish/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/knish.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'knish/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "knish"
+  spec.version       = Knish::VERSION
+  spec.authors       = ["Kane Baccigalupi"]
+  spec.email         = ["baccigalupi@gmail.com"]
+  spec.summary       = %q{File backed data models, excellent for CMS apps!}
+  spec.description   = %q{The problem with CMSs is that you really want your application content in source control,
+  not a database. Knish provides a structured data model for saving data to json, and formatted html to markdown}
+  spec.homepage      = "http://github.com/baccigalupi/knish"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

data/lib/knish.rb

@@ -0,0 +1,36 @@
+require 'json'
+require 'forwardable'
+require 'delegate'
+require 'fileutils'
+
+require "knish/version"
+require "knish/delegate_inspector"
+require "knish/existing_models"
+require "knish/db_config"
+require "knish/model_config"
+require "knish/writer"
+require "knish/reader"
+require "knish/builder"
+require "knish/model"
+require "knish/collection"
+require "knish/collection_config"
+require "knish/member"
+
+module Knish
+  def self.clear_config
+    @config = nil
+  end
+
+  def self.config
+    @config ||= DbConfig.new
+  end
+
+  def self.configure(&block)
+    block.call(config)
+  end
+
+  def self.build(path, &block)
+    builder = Builder.new(path, &block)
+    builder.make_model
+  end
+end

data/lib/knish/builder.rb

@@ -0,0 +1,35 @@
+module Knish
+  class Builder
+    attr_reader :collection_name, :block
+
+    def initialize(collection_name, &block)
+      @collection_name = collection_name
+      @block = block
+    end
+
+    def make_model
+      klass = Class.new(Model)
+      klass.config = config
+      klass.send(:attr_accessor, *config.all_attributes)
+      klass.send(:attr_writer, *config.collections)
+      add_collections(klass, config.collections)
+      klass
+    end
+
+    def add_collections(klass, collections)
+      collections.each do |collection|
+        klass.class_eval <<-RUBY, __FILE__, __LINE__
+          def #{collection}
+            @#{collection} ||= Collection.new('#{collection}', config)
+          end
+        RUBY
+      end
+    end
+
+    def config
+      model_config = ModelConfig.new(Knish.config.clone, collection_name)
+      block.call(model_config)
+      model_config
+    end
+  end
+end

data/lib/knish/collection.rb

@@ -0,0 +1,41 @@
+module Knish
+  class Collection < SimpleDelegator
+    attr_reader :name, :config
+
+    def initialize(name, parent_config)
+      super([])
+      @name = name
+      @config = CollectionConfig.new(parent_config, name)
+    end
+
+    def add(model)
+      configure(model)
+      push(model)
+    end
+
+    alias :<< :add
+
+    def save
+      each(&:save)
+    end
+
+    def load
+      clear
+      config.generic_model_configs.each do |c|
+        push(
+          Member.new(config, c).loaded_model
+        )
+      end
+      self
+    end
+
+    def next_id
+      config.next_id + select{|m| !m.persisted? }.size
+    end
+
+    def configure(model)
+      model.config = config.member_config(model.config)
+      model
+    end
+  end
+end

data/lib/knish/collection_config.rb

@@ -0,0 +1,53 @@
+module Knish
+  class CollectionConfig < SimpleDelegator
+    attr_accessor :db_config, :path, :model_config, :unpersisted_count
+
+    def initialize(model_config, path)
+      super(model_config.db_config)
+      @path = path
+      @db_config = model_config.db_config
+      @model_config = model_config
+      @unpersisted_count = 0
+    end
+
+    def collection_root
+      "#{model_config.model_root}/#{path}"
+    end
+
+    def next_id
+      ExistingModels.new(collection_root).next_id + unpersisted_count
+    end
+
+    def generic_model_configs
+      ExistingModels.new(collection_root).ids.map { |id| member_config(generic_config, id) }
+    end
+
+    def generic_config
+      ModelConfig.new(Knish.config, '')
+    end
+
+    def inspect
+      DelegateInspector.new(self,
+        [:db_config, :model_config, :path]
+      ).to_inspect
+    end
+
+    def member_config(original_config, id=nil)
+      config = original_config.clone
+      config.id = member_id(id)
+      config.path = "#{model_config.path}/#{model_config.id}/#{path}"
+      config
+    end
+
+    private
+
+    def member_id(id)
+      return id if id
+      id = next_id
+      self.unpersisted_count += 1
+      id
+    end
+
+  end
+end
+

data/lib/knish/db_config.rb

@@ -0,0 +1,29 @@
+module Knish
+  class DbConfig
+    attr_writer :db_directory, :view_to_db_path, :data_filename, :db_name
+
+    def db_directory
+      @db_directory ||= `pwd`.chomp
+    end
+
+    def db_root
+      "#{db_directory}/#{db_name}"
+    end
+
+    def db_name
+      @db_name ||= 'knish'
+    end
+
+    def view_to_db_path
+      @view_to_db_path ||= '/../..'
+    end
+
+    def data_filename
+      @data_filename ||= 'data.json'
+    end
+
+    def type_key
+      '___type'
+    end
+  end
+end

data/lib/knish/delegate_inspector.rb

@@ -0,0 +1,17 @@
+module Knish
+  class DelegateInspector < Struct.new(:object, :attributes)
+    def to_inspect
+      "#<#{object.class.name}:#{memory_location} #{mapped_attributes.join(' ')}>"
+    end
+
+    def memory_location
+      '0x00%x' % (object.object_id << 1)
+    end
+
+    def mapped_attributes
+      attributes.map do |attr|
+        "@#{attr}=#{object.send(attr).inspect}"
+      end
+    end
+  end
+end

data/lib/knish/existing_models.rb

@@ -0,0 +1,28 @@
+module Knish
+  class ExistingModels < Struct.new(:path)
+    def next_id
+      (ids.max || 0) + 1
+    end
+
+    def ids
+      paths.map{|path| id(path) }.compact
+    end
+
+    def paths
+      Dir.glob("#{path}/*")
+    end
+
+    def data
+      paths.map { |path|
+        Data.new(id(path), path) if id(path)
+      }.compact
+    end
+
+    def id(path)
+      last = path.split('/').last
+      last && last.to_i
+    end
+
+    Data = Struct.new(:id, :path)
+  end
+end

data/lib/knish/member.rb

@@ -0,0 +1,31 @@
+module Knish
+  class Member < Struct.new(:collection_config, :config)
+    def model
+      return @model if @model
+      @model = model_class.new(id: config.id)
+      @model.config = collection_config.member_config(@model.config, config.id)
+      @model
+    end
+
+    def loaded_model
+      model.load
+      model
+    end
+
+    def class_name
+      data[config.type_key]
+    end
+
+    def model_class
+      class_name && eval(class_name)
+    end
+
+    def data
+      @data ||= reader.get_json
+    end
+
+    def reader
+      Reader.new(config)
+    end
+  end
+end

data/lib/knish/model.rb

@@ -0,0 +1,87 @@
+module Knish
+  class Model
+    if defined?(ActiveModel::Model)
+      include ActiveModel::Model
+
+      def self.model_name
+        ActiveModel::Name.new(self, omitted_namespace)
+      end
+    end
+
+    attr_writer :config
+
+    def initialize(attrs=nil)
+      attrs ||= {}
+      set(attrs)
+    end
+
+    extend Forwardable
+
+    def_delegators :config, :id, :id=
+    def_delegators :reader, :persisted?
+
+    def save
+      writer.save_json(data_attributes)
+      writer.save_markdown(markdown_attributes)
+      true
+    end
+
+    def load
+      set(reader.get_json)
+      set(reader.get_markdown)
+      true
+    end
+
+    def set(attrs)
+      attrs.each do |key, value|
+        next if key.to_sym == config.type_key.to_sym
+        public_send("#{key}=", value)
+      end
+    end
+
+    def template(key)
+      reader.template(key)
+    end
+
+    def config
+      @config ||= self.class.config.clone
+    end
+
+    class << self
+      attr_accessor :config
+    end
+
+    def self.omitted_namespace
+      config && config.omitted_namespace
+    end
+
+    private
+
+    def collections
+      config.collections.map {|collection| send(collection) }
+    end
+
+    def data_attributes
+      extract_local_attributes(config.data_attributes).merge(___type: self.class.to_s)
+    end
+
+    def markdown_attributes
+      extract_local_attributes(config.markdown_attributes)
+    end
+
+    def extract_local_attributes(keys)
+      keys.inject({}) do |hash, key|
+        hash[key] = public_send(key)
+        hash
+      end
+    end
+
+    def writer
+      @writer ||= Writer.new(config)
+    end
+
+    def reader
+      @reader ||= Reader.new(config)
+    end
+  end
+end