jsondb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f12ca944e1c7a4a054b787da398a96998aa78f37
+  data.tar.gz: 29b3f64e40cfd3cf4355b3fe3e9ce255105c7b86
+SHA512:
+  metadata.gz: e01e62d7f226e0c81cd006294f54b5b628ba830d2fed14c1870eff0fd9484497817900e11ee4087bca5449131b9a613eeab385d5c75b73d83c3380774888cd15
+  data.tar.gz: 6a7324ba2fffb7c7cc5e9232dbe247b5e5e8bf30c4fba2daf81212161a7295ddb843e443fe89c0cafbe2b5223bb4a94bedd2696645523dcdb7c38b89b4c025d6

data/lib/jsondb.rb

@@ -0,0 +1,11 @@
+#it depends on json_pure
+require 'json/pure'
+
+this_dir = File.dirname(__FILE__)
+require File.join(this_dir, 'jsondb/file_ops')
+require File.join(this_dir, 'jsondb/db')
+require File.join(this_dir, 'jsondb/validation')
+require File.join(this_dir, 'jsondb/table')
+require File.join(this_dir, 'jsondb/field')
+require File.join(this_dir, 'jsondb/record')
+require File.join(this_dir, 'jsondb/resultset')

data/lib/jsondb/db.rb

@@ -0,0 +1,56 @@
+#db.rb
+class Db
+
+	attr_reader :root, :tables, :writeable
+
+	def initialize(root, writeable = true)
+		@root = root
+		@writeable = writeable
+		@file = FileOps.new(@root, '_db.json', 'db', @writeable)
+		load_tables
+	end
+	
+	def table(name)
+		@tables[name] ||= Table.new(name, @root, Time.now.to_i, @writeable)
+	end
+
+	def table_add(name)
+		if @tables.keys.include?(name)
+			raise "Table '#{name}' already defined."
+		else
+			@tables[name] = Table.new(name, @root, Time.now.to_i, @writeable)
+		end
+	end
+
+	def table_drop(name)
+		@tables[name].drop
+		@tables.delete(name)
+	end
+
+	def table_names
+		@tables.keys
+	end
+
+	def persist
+		@file.contents['tables'] = {}
+		@tables.each do |name, table|
+			if table.persisted == false
+				table.updated_at = Time.now.to_i
+				table.persist
+			end
+			@file.contents['tables'][name] = { "name" => name, "updated_at" => table.updated_at }
+		end
+		return @file.save
+	end
+
+	private
+
+	def load_tables
+		@tables_in_file = @file.contents['tables'] || Hash.new({})
+		@tables = Hash.new
+		@tables_in_file.each do |name, values|
+			@tables[name] = Table.new(name, @root, values['updated_at'], @writeable)
+		end
+	end
+
+end

data/lib/jsondb/field.rb

@@ -0,0 +1,47 @@
+class Field
+
+	include Validation
+
+	attr_reader :name, :type, :nullable, :default
+
+	def initialize(name)
+		allowed_name?(name)
+		
+		@name = name
+		@nullable = true
+		@default = nil
+		@type = "String"
+	end
+
+	def type=(_class)
+		@type = allowed?(_class)
+	end
+
+	def type
+		@type
+	end
+
+	def nullable=(value)
+		@nullable = validate_type("Bool", value)
+	end
+
+	def nullable
+		@nullable
+	end
+
+	def default=(value)
+		@default = validate_type(@type, value)
+	end
+
+	def default
+		@default
+	end
+
+	def to_hash
+		data = Hash.new
+		data['type']		= @type
+		data['nullable']	= @nullable
+		data['default']		= @default
+		data
+	end
+end

data/lib/jsondb/file_ops.rb

@@ -0,0 +1,71 @@
+class FileOps
+
+  attr_reader :writeable, :filename, :folder, :raw, :new_file
+
+  def initialize(folder, filename, filetype, writeable = true)
+    @folder = folder
+    @writeable = writeable
+    @filename = File.join(@folder, filename)
+    @filetype = filetype
+    if exists?(@folder)
+      load 
+    else
+      raise "Folder '#{@folder}' does not exists."
+    end
+  end
+
+  def contents=(contents)
+    @contents = contents
+  end
+
+  def contents
+    @contents
+  end
+
+  def save
+    return false if @writeable == false
+    @file = File.open(@filename, 'w')
+    @raw = JSON.pretty_generate(@contents)
+    @file.write(@raw)
+    @file.close
+    @new_file = false
+    return true
+  end
+
+  def destroy
+    File.delete(@filename) if exists?(@filename)
+  end
+
+  def close
+    @file.close if @file
+  end
+
+  private
+
+  def exists?(file)
+    File.exists?(File.expand_path(file))
+  end
+
+  def load
+    @new_file = !exists?(@filename)
+    if exists?(@filename)
+      @file = File.open(@filename, 'r') 
+      @raw = @file.read
+    else
+      @raw = default_content
+    end
+    @contents = JSON.parse(@raw)
+    @file.close if @file
+  end
+
+  def default_content
+    case @filetype
+    when 'db'
+      '{ "tables": {} }'
+    when 'table_structure'
+      '{ "last_id" : 0, "fields": {} }'
+    when 'table_records'
+      '{ }'
+    end
+  end
+end

data/lib/jsondb/record.rb

@@ -0,0 +1,90 @@
+class Record
+
+	include Validation
+
+	def initialize(fields, data = nil)
+		@fields = fields
+		if data.nil?
+			@record = Hash.new
+			@new = true
+			self.id = 0
+		else
+			@record = data
+			@new = false
+		end
+		@persisted = false
+		set_defaults # we need to apply again the defaults
+	end
+
+	def method_missing(name, *args)
+		attribute = name.to_s
+
+		if @fields.to_hash.keys.include?(attribute.sub('=', ''))
+			if attribute =~ /=$/
+				if @record[attribute] != args[0]
+					@record[attribute.sub('=', '')] = args[0]
+					@persisted = true
+				end
+			else
+				@record[attribute]
+			end
+		else
+			raise "Column '#{attribute.sub('=', '')}' do not exists"
+		end
+	end
+
+	def save_with_id(id)
+		self.created_at = Time.now.to_i
+		self.updated_at = Time.now.to_i
+		self.id = id
+		@new = false
+		@persisted = false
+	end
+
+	def update
+		self.updated_at = Time.now.to_i
+		@new = false
+		@persisted = false
+	end 
+
+	def to_hash
+		@record
+	end
+
+	def new?
+		@new
+	end
+
+	def persisted?
+		@persisted
+	end
+
+	def created_at
+		Time.at(@record['created_at'])
+	end
+
+	def persisted_at
+		Time.at(@record['updated_at'])
+	end
+
+	private
+
+	def set_defaults
+		@fields.each do |name, values|
+			if values.default and @record[name].nil?
+				@record[name] = values.default
+			end
+		end
+	end
+
+	# # TODO : Add Validation
+
+	# def save!
+	# 	raiseif(save, false, "Error saving the record.")
+	# end
+
+	# def save
+	# 	return @table_class.save
+	# end
+
+end

data/lib/jsondb/resultset.rb

@@ -0,0 +1,107 @@
+class ResultSet
+
+	include Validation
+
+	def initialize(table_class, array_fields = nil)
+		@fields 		= array_fields || table_class.fields.to_hash.keys
+		# actually it deletes the record!
+		@result 		= Hash.new()
+		table_class.records.each do |k, v|
+			@result[k] = v.dup
+		end
+
+		@equal 			= Hash.new
+		@min 				= Hash.new
+		@max 				= Hash.new
+		@like 			= Hash.new
+	end
+
+	def equal(field, value)
+		@equal[field] = value
+		return self
+	end
+
+	def min(field, value)
+		@min[field] = value
+		return self
+	end
+
+	def max(field, value)
+		@max[field] = value
+		return self
+	end
+
+	def like(field, value)
+		@like[field] = value
+		return self
+	end
+
+	def result
+		result_equal 		if @equal.keys.count 	!= 0
+		result_min 			if @min.keys.count 		!= 0
+		result_max 			if @max.keys.count 		!= 0
+		result_like 		if @like.keys.count 	!= 0
+		return @result
+	end
+
+	private
+
+	def result_equal
+		@equal.each do |col_name, col_value|
+			this_result = Array.new
+			@result.each do |id, record|
+				r = record.send col_name.to_sym
+				if r == col_value
+					this_result << id
+				end
+			end
+			remove_if_key_not_in(this_result)
+		end
+	end
+
+	def result_min
+		@min.each do |col_name, col_value|
+			this_result = Array.new
+			@result.each do |id, record|
+				r = record.send col_name.to_sym
+				if r >= col_value
+					this_result << id
+				end
+			end
+			remove_if_key_not_in(this_result)
+		end
+	end
+
+	def result_max
+		@max.each do |col_name, col_value|
+			this_result = Array.new
+			@result.each do |id, record|
+				r = record.send col_name.to_sym
+				if r <= col_value
+					this_result << id
+				end
+			end
+			remove_if_key_not_in(this_result)
+		end
+	end
+
+	def result_like
+		@like.each do |col_name, col_value|
+			this_result = Array.new
+			@result.each do |id, record|
+				r = record.send col_name.to_sym
+				if r =~ Regexp.new(col_value)
+					this_result << id
+				end
+			end
+			remove_if_key_not_in(this_result)
+		end
+	end
+
+	def remove_if_key_not_in(arr)
+		@result.keys.each do |key|
+			@result.delete(key) if arr.include?(key) == false
+		end
+	end
+
+end

data/lib/jsondb/table.rb

@@ -0,0 +1,143 @@
+class Table
+
+	attr_accessor :updated_at
+	attr_reader :fields, :records, :last_id, :persisted
+
+	include Validation
+
+	def initialize(name, folder, updated_at, writeable)
+		allowed_name?(name)
+		
+		@name = name
+		@folder = folder
+		@writeable = writeable
+
+		@structure_file = FileOps.new(@folder, "#{@name}_structure.json", 'table_structure', @writeable)
+		@records_file   = FileOps.new(@folder, "#{@name}_records.json", 'table_records', @writeable)
+
+		# last_id
+		@last_id = @structure_file.contents["last_id"]
+
+		# Fields
+		@fields = Hash.new
+
+		if @structure_file.contents["fields"].keys.count
+			@structure_file.contents["fields"].each do |name, field|
+				@fields[name] ||= Field.new(name)
+			end
+		end
+		# add id and timestamps fields if not exists...
+		add_main_fields 
+
+		# Fills records hash
+		@records_contents = @records_file.contents || {}
+		@records = Hash.new
+		@records_contents.each do |id, record|
+			@records[id] = Record.new(@fields, record)
+		end
+
+		@updated_at = Time.now.to_i if @structure_file.new_file
+		@persisted = !@structure_file.new_file
+
+	end
+
+	def field(name)
+		return @fields[name] ||= Field.new(@name)
+	end
+
+	def records
+		return @records
+	end
+
+	def new_record
+		@persisted = false
+		@updated_at = Time.now.to_i
+		return Record.new(@fields)
+	end
+
+	def query(array_fields = nil)
+		return select(array_fields)
+	end
+
+	def select(array_fields = nil)
+		return ResultSet.new(self, array_fields)
+	end
+
+	def insert(record)
+		if record.id != 0
+			raise "Record already exists."
+		else
+			id = new_id
+			record.save_with_id(id)
+			@records[id] = record
+			@persisted = false
+			return id
+		end
+	end
+
+	def update(record)
+		@persisted = false
+		@records[record.id] = record.update
+	end
+
+	def delete(record)
+		@persisted = false
+		@records.delete(record.id)
+	end
+
+	def drop
+		@structure_file.destroy
+		@records_file.destroy
+	end
+
+	def persist
+		@structure_file.contents['last_id'] = @last_id
+		@structure_file.contents['fields'] = @fields.to_hash
+		@structure_file.save
+
+		@records_file.contents = {}
+		@records.each do |id, record|
+			@records_file.contents[id] = record.to_hash
+		end
+		@records_file.save
+		@updated_at = Time.now.to_i
+		@persisted = true
+	end
+
+	def to_hash
+		return { "name" => @name, "updated_at" => @updated_at }
+	end
+
+	def updated_at_time
+		Time.at(@updated_at)
+	end
+
+	private
+
+	def new_id
+		@last_id = @last_id + 1
+		return @last_id
+	end
+
+	def add_main_fields
+		if @fields["id"].nil?
+			id_field = self.field('id')
+			id_field.type 				= "Fixnum"
+			id_field.nullable 		= false
+			id_field.default 		= 0
+		end
+		if @fields["created_at"].nil?
+			created_field = self.field('created_at')
+			created_field.type 				= "Fixnum"
+			created_field.nullable 		= false
+			created_field.default 		= 0
+		end
+		if @fields["updated_at"].nil?
+			updated_field = self.field('updated_at')
+			updated_field.type 				= "Fixnum"
+			updated_field.nullable 		= false
+			updated_field.default 		= 0
+		end
+	end
+
+end

data/lib/jsondb/validation.rb

@@ -0,0 +1,86 @@
+module Validation
+
+	def allowed_types
+		["String", "Fixnum", "Integer", "Float", "Time", "Bool"]
+	end
+
+	def allowed_name?(name)
+		if (name =~ /^[a-zA-Z0-9_]+$/).nil?
+			raise "Name not allowed. /^[a-zA-Z0-9_]+$/"
+		else
+			return true
+		end
+	end
+
+	def allowed?(type)
+		if allowed_types.include?(type.to_s)
+			return type.to_s
+		else
+			raise "Validation: Type '#{type.to_s}' not allowed"
+		end
+	end
+
+	def validate_type(_class, _value)
+		case _class
+		when "Bool"
+			bool?(_class, _value)
+		when "String"
+			string?(_class, _value)
+		when "Fixnum", "Integer", "Float"
+			numeric?(_class, _value)
+		when "Time"
+			time?(_class, _value)
+		else
+			raise "Validation: '#{_class}' type not allowed"
+		end
+	end
+
+	private
+	
+	def bool?(_class, _value)
+		case _value
+		when true, false
+			return _value
+		else
+			raise "Validation: Bool: Not a Bool type"
+		end
+	end
+
+	def string?(_class, _value)
+		if _class == _value.class.to_s
+			return _value
+		else
+			raise "Validation: #{_class}: Value '#{_value}' not allowed for '#{_class}' type"
+		end
+	end
+
+	def numeric?(_class, _value)
+		case _class
+	  when "Fixnum", "Integer"
+	    if _value.class.to_s == "Fixnum"
+	      return _value
+	    else
+	      raise "Validation: '#{_value}' is not Integer"
+	    end
+		when "Float"
+			case eval(_value).class.to_s
+			when "Float"
+				return _value
+			when "Fixnum"
+				return _value.to_f
+			else
+				raise "Validation: '#{_value} is not a Float type"	
+			end
+		else
+			raise "Validation: '#{_value} is not a Numeric type"
+		end
+	end
+
+	def time?(_class, _value)
+		if eval(_value).class.to_s != "Time"
+			raise "Validation: '#{_value} is not a Time type" 
+		end
+	end
+	
+end
+

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: jsondb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Antonio Fernandez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_pure
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.8.1
+description: Local Database using JSON files
+email: antoniofernandezvara@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/jsondb.rb
+- lib/jsondb/db.rb
+- lib/jsondb/field.rb
+- lib/jsondb/file_ops.rb
+- lib/jsondb/record.rb
+- lib/jsondb/resultset.rb
+- lib/jsondb/table.rb
+- lib/jsondb/validation.rb
+homepage: http://fernandezvara.github.io/jsondb/
+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.2.2
+signing_key: 
+specification_version: 4
+summary: lib to manage tiny databases in plain JSON files
+test_files: []