file_db 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 60f8985b783b22dce4f2d0bfd8869bbef4e42aa8
+  data.tar.gz: fa31bf722121dd5b289970891e4e61bbaf3a5b5c
+SHA512:
+  metadata.gz: 0d068f1075e82294529a363cb25f4d93795c6995955c86fca7b84da0edd055d552e7f8b7f2abd93907defab9efc916379524d30a7c8907e62b2d7d6dd6d8da8d
+  data.tar.gz: cf4f679eb57937297a7f7ca0f4ba3974993acfc5d9240b6400f67e06c576c3b7fca0dcff353aa0ec2e0daee6d7c7692ee6e78efc0e11dd23fe9af1ffd880ee04

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 robst
+
+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,143 @@
+# FileDb
+
+You need to store data into a small type of database, like CSV and want a better way to handle it? So you can use `FileDb` for this. It stores all data for a model into CSV files and create accessor for you.
+
+## Installation
+
+hm, yeah. just add this to your Gemfile:
+
+```ruby
+gem 'file_db', '~> 0.1.0'
+```
+
+And then execute:
+```
+  $ bundle
+```
+Or install it yourself as:
+```
+  $ gem install file_db
+```
+
+Huh, ready to use!
+
+## Usage
+
+### Configuration
+
+First configure the storage directory:
+
+```ruby
+FileDb::Configuration.configure data_directory: 'data'
+```
+
+Make sure, the directory exists or use the build in check for checking and creating the data directory:
+```ruby
+FileDb::Database.database_check!
+```
+
+ok, lets go to create a model.
+
+```ruby
+class User < FileDb::Model
+
+end
+```
+
+thats it. now we got a user model which actually just storing an id. lets add `columns` for this.
+
+```ruby
+class User < FileDb::Model
+  columns :name, :email
+end
+```
+
+Now lets create some entries.
+
+```ruby
+my_user = User.new name: 'rob'
+my_user.save
+```
+now the `User` is stored under `data/user.csv`. You should find an entry like this one:
+
+```
+1466311874,rob,
+```
+
+Let's get them user back:
+```ruby
+User.find 1466311874
+-> #<User:0x00000004651798 @name="rob", @id="1466311874", @email=nil>
+```
+
+you can access all attributes like `attr_accessor`
+
+```ruby
+User.find(1466311874).name
+-> rob
+```
+
+The accessors will be created automaticly for you.
+Let's find all users named with rob. I think you know how get this to work:
+
+```ruby
+User.where(name: 'rob')
+-> [#<User:0x00000004651798 @name="rob", @id="1466311874", @email=nil>]
+```
+
+rename the user:
+
+```ruby
+user = User.find(1466311874)
+-> #<User:0x00000004651798 @name="rob", @id="1466311874", @email=nil>
+user.name = 'bob'
+user.email = 'test@example.com'
+user.save
+User.find(1466311874)
+-> #<User:0x00000004651798 @name="bob", @id="1466311874", @email=test@example.com>
+```
+
+You want to use another table than `user`? So just configure it:
+
+```ruby
+class User < FileDb::Model
+  columns :name, :email
+  set_table_name 'crazy'
+end
+```
+
+## The MIT License (MIT)
+
+Copyright (c) 2015  [Robert Starke](robertst81+github@gmail.com)
+
+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.
+
+## Questions?
+
+If you have further questions, code smells, hints or a beer, just contact me :)
+
+
+
+
+
+
+
+
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "file_db"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/file_db.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'file_db/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "file_db"
+  spec.version       = FileDb::VERSION
+  spec.authors       = ["Robert Starke"]
+  spec.email         = ["robertst81@gmail.com"]
+
+  spec.summary       = %q{Use CSV Files like a Database with ActiveRecord Feeling.}
+  spec.description   = %q{You need to store informationen in a CSV File, because there is no need for a database? You can use FileDb to store all informationen in a CSV File and search in it like ActiveRecord (User.find(1212). See detailed Information at the github Page.}
+  spec.homepage      = "https://github.com/robst/file_db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/file_db/columns.rb

@@ -0,0 +1,25 @@
+module FileDb
+  module Columns
+
+    def columns *names
+      return @columns if names.empty?
+      names.delete(:id)
+      @columns = [:id] + names
+
+      @columns.each do |name|
+        define_method name do
+          instance_variable_get "@#{name}"
+        end 
+        define_method "#{name}=" do |new_val|
+          instance_variable_set "@#{name}", new_val
+        end
+      end 
+
+    end
+
+    def column_index column
+      @columns.index column
+    end
+
+  end
+end

data/lib/file_db/configuration.rb

@@ -0,0 +1,20 @@
+module FileDb
+  module Configuration
+    def self.configure options = {}
+      @configuration = default_options.merge(options)
+      FileDb::Database.database_check!
+    end
+
+    def self.configured option
+      configuration[option]
+    end
+
+    def self.configuration
+      @configuration ||= default_options
+    end
+
+    def self.default_options
+      { data_directory: 'data'  }
+    end
+  end
+end

data/lib/file_db/convert.rb

@@ -0,0 +1,11 @@
+module FileDb
+  module Convert
+
+    def to_csv
+      self.class.columns.inject([]) do |csv, column|
+        csv << send(column)
+      end
+    end
+  end
+
+end

data/lib/file_db/data.rb

@@ -0,0 +1,25 @@
+module FileDb
+  module Data
+    def initialize params= {}
+      params.each do |key, value|
+        next unless self.class.columns.include?(key)
+        send("#{key}=", value)
+
+      end 
+    end
+    
+    def save
+      if persisted?
+        self.class.update_database self
+      else
+        self.id = Time.now.to_i
+        self.class.append_to_database self
+      end
+    end
+
+
+    def persisted?
+      !id.nil?
+    end
+  end  
+end

data/lib/file_db/database.rb

@@ -0,0 +1,20 @@
+module FileDb
+  module Database
+    def self.database_check!
+      create_data_directory! unless exist_data_directory?
+    end
+    
+    private
+    def self.data_directory
+      Configuration.configured(:data_directory)
+    end
+
+    def self.exist_data_directory?
+      File.exist? data_directory
+    end
+
+    def self.create_data_directory!
+      Dir.mkdir data_directory
+    end
+  end
+end

data/lib/file_db/model.rb

@@ -0,0 +1,7 @@
+module FileDb
+  class Model
+    extend FileDb::Query
+    include FileDb::Data
+    include FileDb::Convert
+  end
+end

data/lib/file_db/query.rb

@@ -0,0 +1,36 @@
+module FileDb
+  module Query
+    include FileDb::Columns
+    include FileDb::Table
+
+    def find id
+      where(id: id).first
+    end
+
+    def where conditions
+      results = []
+      searching_database do |data_row|
+        if conditions_match?(conditions,data_row)
+          results << create_object(data_row)
+        end
+      end
+      results
+    end
+
+    def create_object values
+      hash = {}
+      columns.each do |column|
+        hash[column] = values[column_index(column)]
+      end
+      new hash
+    end
+
+    def conditions_match? conditions, data
+      conditions.each do |key, value|
+        return false unless data[column_index(key)].eql?(value.to_s)
+      end
+     true 
+    end
+
+  end
+end

data/lib/file_db/table.rb

@@ -0,0 +1,45 @@
+module FileDb
+  module Table
+    def table_name
+      @table_name ||= self.new.class.to_s.gsub(/(.)([A-Z])/,'\1_\2').downcase
+    end
+
+    def set_table_name name
+      @table_name = name
+    end
+
+    def searching_database
+      return unless File.exist?(table_file_location)
+      ::CSV.foreach(table_file_location) do |row| 
+        yield row 
+      end
+    end
+
+    def append_to_database entry_object
+      ::CSV.open(table_file_location, "a") do |csv|
+        csv << entry_object.to_csv
+      end
+    end
+
+    def update_database entry_object
+      records = []
+      ::CSV.foreach(table_file_location) do |row|
+        if row[0]==entry_object.id.to_s
+          records << entry_object.to_csv
+        else
+          records << row
+        end
+      end
+
+      ::CSV.open(table_file_location, "w") do |csv|
+        records.each do |record|
+          csv << record
+        end
+      end
+    end
+
+    def table_file_location
+      File.join(Configuration.configured(:data_directory), "#{table_name}.csv")
+    end
+  end
+end

data/lib/file_db/version.rb

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

data/lib/file_db.rb

@@ -0,0 +1,14 @@
+require "csv"
+require "file_db/version"
+require "file_db/configuration"
+require "file_db/database"
+require "file_db/columns"
+require "file_db/table"
+require "file_db/data"
+require "file_db/query"
+require "file_db/convert"
+require "file_db/model"
+
+module FileDb
+  # Your code goes here...
+end

metadata

@@ -0,0 +1,109 @@
+--- !ruby/object:Gem::Specification
+name: file_db
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Robert Starke
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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: You need to store informationen in a CSV File, because there is no need
+  for a database? You can use FileDb to store all informationen in a CSV File and
+  search in it like ActiveRecord (User.find(1212). See detailed Information at the
+  github Page.
+email:
+- robertst81@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- file_db.gemspec
+- lib/file_db.rb
+- lib/file_db/columns.rb
+- lib/file_db/configuration.rb
+- lib/file_db/convert.rb
+- lib/file_db/data.rb
+- lib/file_db/database.rb
+- lib/file_db/model.rb
+- lib/file_db/query.rb
+- lib/file_db/table.rb
+- lib/file_db/version.rb
+homepage: https://github.com/robst/file_db
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Use CSV Files like a Database with ActiveRecord Feeling.
+test_files: []