yamlet 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c14bd6ad734910c22346d831a4b48e2748696d27
+  data.tar.gz: 1d732ca97ab906be3746e00523e6f1659c8855be
+SHA512:
+  metadata.gz: 98ccb512e83c59fbfae23b12a29c8e6c951bc1873aee373d36cdf59dd1e63ad0cd23de2719d7922bae4bd649b8b720482f9871cd5fca685c9dcaa3ca2d8cca15
+  data.tar.gz: 060becb5ec15352c24fdb180633808339cefc5e0d6e03f2e148b561e9b72de33ce1d6952b72bef269ca7c6c537743a58f6f81ed2ed62297cc5feffe472ac7208

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,118 @@
+# Yamlet
+
+  Yamlet is a tiny library (< 100 lines of code) which injects CRUD
+functionalities to your Plain Old Ruby Objects and store data on a YAML file using
+[YAML::Store].
+
+  Perfect for creating small applications **(for demo/prototyping purposes)**
+where you only need a single YAML file to store everything and removes the
+constraint of setting up a database.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yamlet'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yamlet
+
+Usage
+--------
+
+### Configuration
+
+First, create a YAML file somewhere then tell Yamlet where to find that file which we'll be using for storing data.
+
+```ruby
+  Yamlet.repository_file = "/path/to/repository.yml"
+```
+
+**NOTE: A `RepositoryNotFound` error will be raised when Yamlet can't locate the YAML file.**
+
+### Using Yamlet with Classes
+
+```ruby
+class User
+  include Yamlet.model
+
+  #...
+end
+```
+
+After including `Yamlet.model` in your class, notice that the YAML file will
+automatically be updated.
+
+```yaml
+# /path/to/repository.yml
+
+---
+user: []
+```
+
+### Methods
+
+
+#### `.all`
+
+
+```ruby
+  User.all   #=> []
+  User.create(name: "Grumpy Kid")
+
+  User.all #=> [{"id"=>1, "name"=>"Grumpy Kid"}]
+```
+
+#### `.find`
+
+```ruby
+  User.find(1) #=> {"id"=>1, "name"=>"Grumpy Kid"}
+```
+
+#### `.create`
+
+```ruby
+  User.create(name: "Grumpy Kid")
+  #=> {"id"=>1, "name"=>"Grumpy Kid"}
+```
+
+#### `.update`
+
+```ruby
+  User.update(1, name: "Grumpy Dad")
+  #=> {"id"=>1, "name"=>"Grumpy Dad"}
+```
+
+#### `.destroy`
+
+```ruby
+  User.destroy(1)
+
+  User.all #=> []
+```
+
+#### `.destroy_all`
+
+```ruby
+  5.times { |i| User.create(name: "Grumpy #{i}") }
+
+  User.destroy_all #=> []
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/yamlet/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
+
+[YAML::Store]: http://ruby-doc.org/stdlib-2.1.0/libdoc/yaml/rdoc/YAML/Store.html

data/Rakefile

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

data/lib/yamlet/version.rb

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

data/lib/yamlet.rb

@@ -0,0 +1,92 @@
+require "yaml/store"
+require "yamlet/version"
+
+module Yamlet
+  RepositoryNotFound = Class.new(StandardError)
+
+  @@repository_file = nil
+
+  def self.repository_file
+    @@repository_file
+  end
+
+  def self.repository_file=(file)
+    @@repository_file = file
+  end
+
+  module Repository
+
+    def self.store
+      @store ||= YAML::Store.new Yamlet.repository_file
+    rescue
+      raise Yamlet::RepositoryNotFound.new("YAML file can't be located")
+    end
+
+  end
+
+  module Model
+    Error = Class.new(StandardError)
+
+    def self.included(klass)
+      klass.define_singleton_method :resource_name, -> {
+        name = klass.to_s.downcase
+        name.gsub!("::", "_") if name.include? "::"
+
+        return name
+      }
+
+      klass.define_singleton_method :store, -> { Yamlet::Repository.store }
+
+      klass.store.transaction { klass.store[klass.resource_name] ||= [] }
+
+      klass.define_singleton_method :all, -> {
+        store.transaction { store[resource_name] }
+      }
+
+      klass.define_singleton_method :find, ->(id) {
+        store.transaction { store[resource_name].select { |s| s["id"] == id }[0] }
+      }
+
+      klass.define_singleton_method :create, ->(attributes = {}) {
+        # Auto increment ids
+        ids = all.empty? ? [0] : all.map { |s| s["id"] }
+        id  = ids[-1].zero? ? 1 : ids[-1].succ
+
+        if attributes.empty?
+          store.transaction { store[resource_name].push({ "id" => id }) }
+        else
+          store.transaction {
+            store[resource_name].push(
+              {}.tap do |hash|
+                hash["id"] = id
+                attributes.each_pair { |k, v| hash[k.to_s] = v }
+              end
+            )
+          }
+        end
+      }
+
+      klass.define_singleton_method :update, ->(id, attributes) {
+        store.transaction {
+          store[resource_name].select { |s| s["id"] == id }[0].tap do |record|
+            attributes.each_pair { |k, v| record[k.to_s] = v } unless record.nil?
+          end
+        }
+      }
+
+      klass.define_singleton_method :destroy, ->(id) {
+        store.transaction { store[resource_name].delete_if { |h| h["id"] == id } }
+      }
+
+      klass.define_singleton_method :destroy_all, -> {
+        store.transaction { store[resource_name] = [] }
+      }
+
+    end
+  end
+
+  def self.model
+    Yamlet::Model
+  end
+
+end

data/yamlet.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yamlet/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yamlet"
+  spec.version       = Yamlet::VERSION
+  spec.authors       = ["Robbie Marcelo"]
+  spec.email         = ["rbmrclo@hotmail.com"]
+  spec.licenses      = ['MIT']
+
+  spec.summary       = %q{Inject CRUD functionalities to your Plain Old Ruby Objects and store data in a YAML file}
+  spec.description   = %q{A small library which injects CRUD functionalities to your Plain Old Ruby Objects and store data in a YAML file}
+  spec.homepage      = "https://github.com/rbmrclo/yamlet"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", '~> 3.0'
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: yamlet
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robbie Marcelo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A small library which injects CRUD functionalities to your Plain Old
+  Ruby Objects and store data in a YAML file
+email:
+- rbmrclo@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- lib/yamlet.rb
+- lib/yamlet/version.rb
+- yamlet.gemspec
+homepage: https://github.com/rbmrclo/yamlet
+licenses:
+- MIT
+metadata: {}
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.6
+signing_key: 
+specification_version: 4
+summary: Inject CRUD functionalities to your Plain Old Ruby Objects and store data
+  in a YAML file
+test_files: []