ruson 1.3.0 → 1.3.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3b5eacde447ed93d7ecffd81ba095d20dad1398687f5138dd7f2267bfd5bacf
-  data.tar.gz: 172098d6792639c7c785eba55332b323785c879ce59458766d60787458b043bc
+  metadata.gz: ed994824268107e491819721d5566eb742d97fc062179ca8f31e5e63c5886c22
+  data.tar.gz: '09e7b5315cc8612dec090b87b2d452db1c1c95338f4a6693ece851a6ba407ccb'
 SHA512:
-  metadata.gz: 1e33b1b04e784cc26494d08fb02a26c9afa9f42bd3595c6f4527da6f59ce937c8df8b4d4b8d95bf528d6ecdbc9384cddc80de738b59d5224098fd9c4c45da3da
-  data.tar.gz: 5cb1a2daa61f905266afb804878a59a0f617e19d530649651c2fbd978c9854c87c243d1002c7baa4e11bc95b6590e75207f4a2af5942941444d378693cbec1f2
+  metadata.gz: 2c8f9b71aa0c7ac63f93bd67ebc3e7b063c16ef118e6e67e846df6d8f445f3b6e0ef5c6a8a9638d0e6b421231afe7a2bc4c9345a0fc036650a7e3da027f446c7
+  data.tar.gz: 2202ca458dd9f29eba01e242e4b302dc8e1730a80eeb563bf036f4f7be01be52570c1a03550b1597ed3d71daf1e25e8fdffbdd1659b035dd6f636c08e7cac63d

data/.gitignore

@@ -10,3 +10,6 @@
 
 # rspec failure tracking
 .rspec_status
+
+# IntelliJ IDEA
+/.idea/

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/README.md

@@ -1,6 +1,6 @@
 # Ruson
 
-Json ORM for Ruby Object
+A Ruby serialization/deserialization library to convert Ruby Objects into JSON and back
 
 ## Installation
 
@@ -123,34 +123,42 @@ post.picture.url #=> 'http://sample.com/picture.png'
 
 ###### Primary classes
 
-* Boolean
-* Integer
-* Float
+* Ruson::Array
+* Ruson::Boolean
+* Ruson::Float
+* Ruson::Integer
+* Ruson::Time
 
 
 post.json
 ```json
 {
   "title": "Ruson",
+  "items": ["orange", "apple"],
   "is_new": "true",
+  "rate": "3.8",
   "view": "1234",
-  "rate": "3.8"
+  "expired_at": 1575608299
 }
 ```
 
 ```ruby
 class Post < Ruson::Base
   field :title
-  field :is_new, class: Boolean
-  field :view, class: Integer
-  field :rate, class: Float
+  field :items, class: Ruson::Array
+  field :is_new, class: Ruson::Boolean
+  field :rate, class: Ruson::Float
+  field :view, class: Ruson::Integer
+  field :expired_at, class: Ruson::Time
 end
 
 json = File.read('post.json')
 post = Post.new(json)
+post.items #=> ["orange", "apple"]
 post.is_new #=> true
-post.view #=> 1234
 post.rate #=> 3.8
+post.view #=> 1234
+post.expired_at #=> 2019-12-06 04:58:19 +0000
 ```
 
 ##### each class
@@ -337,7 +345,50 @@ Ruson.output_folder = './db/'
 #### Find a record by ID
 
 ```ruby
-user = User.find(1) # Searches for a ./db/Users/1.json file
+User.find(1) # Searches for a ./db/Users/1.json file
+
+# Searching a user which doesn't exist
+User.find(1234) #=> nil
+User.find!(1234) #=> raises Ruson::RecordNotFound
+```
+
+#### Find first record
+
+```ruby
+User.first # Loads the first ./db/Users/*.json file.
+
+# Without existing User records
+User.first #=> nil
+User.first! #=> raises Ruson::RecordNotFound
+```
+
+#### Find a record by attributes
+
+post.json
+
+```json
+{
+  "title": "Ruson",
+  "content": "Welcome!"
+}
+```
+
+```ruby
+Post.create(File.read('post.json'))
+```
+
+```ruby
+Post.where(title: 'Ruson')
+#=> [#<Post:0x000055bb2e907b78 @title="Ruson", @content="Welcome!", @id=1>]
+
+Post.where(content: 'Wel')
+#=> []
+
+Post.where(content: 'Welcome!')
+#=> [#<Post:0x000055bb2e907b78 @title="Ruson", @content="Welcome!", @id=1>]
+
+Post.where(title: 'Ruson', content: 'Welcome!')
+#=> [#<Post:0x000055bb2e907b78 @title="Ruson", @content="Welcome!", @id=1>]
 ```
 
 ## Development
@@ -366,7 +417,7 @@ rake install:local    # Build and install ruson-1.2.0.gem into system gems witho
 rake release[remote]  # Create tag v1.2.0 and build and push ruson-1.2.0.gem to rubygems.org
 rake spec             # Run RSpec code examples
 ```
-_`--rm` means delete the container after the command ended._
+_`--rm` means delete the container after the command has ended._
 
 In order to execute the tests:
 

data/lib/ruson/base.rb

@@ -2,6 +2,7 @@ require 'json'
 require 'active_support'
 require 'active_support/core_ext'
 
+require 'ruson/class/array'
 require 'ruson/class/boolean'
 require 'ruson/class/float'
 require 'ruson/class/integer'
@@ -58,6 +59,7 @@ module Ruson
       end
     end
 
+    # ~~~~ Mixins ~~~~
     include Ruson::Converter
     include Ruson::Json
     include Ruson::Nilable
@@ -65,6 +67,15 @@ module Ruson
     include Ruson::Querying
     include Ruson::Value
 
+    # ~~~~ Class Methods ~~~~
+    def self.ensure_output_folder_is_defined
+      return if Ruson.output_folder
+
+      raise ArgumentError, 'No output folder defined. You can define it ' \
+                           'using Ruson.output_folder = "/path/to/db/folder"'
+    end
+
+    # ~~~~ Instance Methods ~~~~
     def initialize(json, root_key: nil)
       params = get_hash_from_json(json)
       params = params[root_key.to_s] unless root_key.nil?
@@ -77,8 +88,9 @@ module Ruson
 
       res.inject({}) do |result, attributes|
         key, value = attributes
-        if self.class.accessors[key] && self.class.accessors[key].key?(:name)
-          result[self.class.accessors[key][:name].to_s] = value
+        accessor = self.class.accessors[key]
+        if accessor && accessor.key?(:name)
+          result[accessor[:name]] = value
         else
           result[key] = value
         end
@@ -86,30 +98,38 @@ module Ruson
       end
     end
 
-    def to_json
-      to_hash.to_json
+    def to_json(options = {})
+      hash = to_hash
+
+      options[:exclude].each { |key| hash.delete(key) } if options[:exclude]
+
+      hash.to_json
     end
 
     private
 
+    def cast_value(value, accessor_options, options = {})
+      check_nilable(value, accessor_options)
+      get_val(value, accessor_options)
+    end
+
     def init_attributes(accessors, params)
       update_attributes(accessors, params)
 
       self.class.attr_accessor(:id)
-      set_attribute(:id, params[:id]) if params[:id]
+      set_attribute(:id, params[:id]) if params && params[:id]
     end
 
-    def set_attribute(attr_name, val)
-      self.send("#{attr_name}=".to_sym, val)
+    def set_attribute(attr_name, value)
+      send("#{attr_name}=".to_sym, value)
     end
 
     def update_attributes(accessors, params)
       accessors.each do |key, options|
-        value = params[options[:name]] || params[key]
+        value = params[options[:name]] || params[key] if params
 
-        check_nilable(value, options)
-        val = get_val(value, options)
-        set_attribute(key, val)
+        casted_value = cast_value(value, options)
+        set_attribute(key, casted_value)
       end
     end
   end

data/lib/ruson/class/array.rb

@@ -0,0 +1,7 @@
+module Ruson
+  class Array
+    def self.new(value)
+      Array(value)
+    end
+  end
+end

data/lib/ruson/class/boolean.rb

@@ -1,14 +1,16 @@
-class Boolean
-  def self.new(value)
-    return value if value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
+module Ruson
+  class Boolean
+    def self.new(value)
+      return value if value.kind_of?(TrueClass) || value.kind_of?(FalseClass)
 
-    case value
-    when 'true'
-      return true
-    when 'false'
-      return false
-    else
-      return false
+      case value
+      when 'true'
+        return true
+      when 'false'
+        return false
+      else
+        return false
+      end
     end
   end
-end
+end

data/lib/ruson/class/float.rb

@@ -1,5 +1,7 @@
-class Float
-  def self.new(value)
-    value.to_f
+module Ruson
+  class Float
+    def self.new(value)
+      value.to_f
+    end
   end
-end
+end

data/lib/ruson/class/integer.rb

@@ -1,5 +1,7 @@
-class Integer
-  def self.new(value)
-    value.to_i
+module Ruson
+  class Integer
+    def self.new(value)
+      value.to_i
+    end
   end
-end
+end

data/lib/ruson/class/time.rb

@@ -1,12 +1,14 @@
-class Time
-  def self.new(value)
-    case value
-    when Integer, Float
-      Time.at(value).to_time
-    when String
-      Time.parse(value).to_time
-    else
-      value
+module Ruson
+  class Time
+    def self.new(value)
+      case value
+      when ::Integer, ::Float
+        ::Time.at(value).to_time
+      when ::String
+        ::Time.parse(value).to_time
+      else
+        value
+      end
     end
   end
-end
+end

data/lib/ruson/converter.rb

@@ -11,7 +11,7 @@ module Ruson
     private
 
     def convert_array_to_hash_value(value)
-      if value.instance_of?(Array)
+      if value.instance_of?(::Array)
         value.inject([]) { |result, v| result << convert_ruson_to_hash_value(v) }
       else
         convert_ruson_to_hash_value(value)

data/lib/ruson/json.rb

@@ -1,8 +1,17 @@
 module Ruson
   module Json
     def get_hash_from_json(json)
+      return unless json
       return json if json.class == ActiveSupport::HashWithIndifferentAccess
+
       (json.class == Hash ? json : JSON.parse(json)).with_indifferent_access
     end
+
+    #
+    # Returns the ID from the JSON file path.
+    #
+    def id_from_file_path(path)
+      File.basename(path, '.json').to_i
+    end
   end
 end

data/lib/ruson/persistence.rb

@@ -2,6 +2,7 @@ module Ruson
   module Persistence
     def self.included(klass)
       klass.extend(ClassMethods)
+      klass.extend(Ruson::Json)
     end
 
     module ClassMethods
@@ -25,13 +26,6 @@ module Ruson
       true
     end
 
-    def ensure_output_folder_is_defined
-      return if Ruson.output_folder
-
-      raise ArgumentError, 'No output folder defined. You can define it ' \
-                           'using Ruson.output_folder = "/path/to/db/folder"'
-    end
-
     def ensure_model_folder_exists
       return if File.exist?(self.class.model_base_path)
 
@@ -45,8 +39,8 @@ module Ruson
 
       id = 0
 
-      Dir.glob(File.join(self.class.model_base_path, '*.json')).each do |file|
-        file_id = File.basename(file, '.json').to_i
+      Dir.glob(File.join(self.class.model_base_path, '*.json')).each do |path|
+        file_id = id_from_file_path(path)
 
         id = file_id if file_id > id
       end
@@ -60,12 +54,12 @@ module Ruson
 
     def write_file_to_disk
       File.open(model_path, 'w') do |file|
-        file.write(to_json)
+        file.write(to_json(exclude: %i[id]))
       end
     end
 
     def save
-      ensure_output_folder_is_defined
+      self.class.ensure_output_folder_is_defined
       generate_uniq_id
       write_file_to_disk
       true

data/lib/ruson/querying.rb

@@ -2,18 +2,28 @@ module Ruson
   module Querying
     def self.included(klass)
       klass.extend(ClassMethods)
+      klass.extend(Ruson::Json)
     end
 
     module ClassMethods
+      def all
+        ensure_output_folder_is_defined
+
+        model_files.collect do |path|
+          json = JSON.parse(File.read(path))
+
+          new(json.merge(id: id_from_file_path(path)))
+        end
+      end
+
       def find(id)
+        ensure_output_folder_is_defined
+
         file_path = File.join(model_base_path, "#{id}.json")
 
         return unless File.exist?(file_path)
 
-        json = JSON.parse(File.read(file_path))
-        json[:id] = id
-
-        new json
+        load(file_path, id: id)
       end
 
       def find!(id)
@@ -23,6 +33,58 @@ module Ruson
 
         record
       end
+
+      def first
+        ensure_output_folder_is_defined
+
+        file_path = model_files.first
+
+        return unless file_path
+
+        id = id_from_file_path(file_path)
+
+        load(file_path, id: id)
+      end
+
+      def first!
+        record = first
+
+        raise Ruson::RecordNotFound unless record
+
+        record
+      end
+
+      def load(file_path, extra_json = {})
+        json = JSON.parse(File.read(file_path))
+
+        json.merge!(extra_json) if extra_json
+
+        new json
+      end
+
+      def where(attributes)
+        ensure_output_folder_is_defined
+
+        query_attributes = attributes.stringify_keys
+
+        models = model_files.collect do |path|
+          json = JSON.parse(File.read(path))
+
+          query_attributes_matches = query_attributes.keys.all? do |key|
+            json[key] == query_attributes[key]
+          end
+
+          if query_attributes_matches
+            new(json.merge(id: id_from_file_path(path)))
+          end
+        end.compact
+
+        Array(models)
+      end
+
+      def model_files
+        Dir.glob(File.join(model_base_path, '*.json'))
+      end
     end
   end
 end

data/lib/ruson/value.rb

@@ -13,7 +13,6 @@ module Ruson
     private
 
     def class_param(param, klass)
-      return nil if param.nil?
       klass.new(param)
     end
 

data/lib/ruson/version.rb

@@ -1,3 +1,3 @@
 module Ruson
-  VERSION = '1.3.0'
+  VERSION = '1.3.5'
 end

data/ruson.gemspec

@@ -7,12 +7,13 @@ Gem::Specification.new do |spec|
   spec.name    = 'ruson'
   spec.version = Ruson::VERSION
   spec.authors = ['klriutsa']
-  spec.email   = ['hiroya.kurushima@litalico.co.jp']
+  spec.email   = ['kurushima.hiroya@gmail.com']
 
-  spec.summary     = %q{ruby json library.}
-  spec.description = %q{ruby json library.}
+  spec.summary     = %q{A Ruby serialization/deserialization library to convert Ruby Objects into JSON and back}
+  spec.description = %q{A Ruby serialization/deserialization library to convert Ruby Objects into JSON and back}
   spec.homepage    = 'https://github.com/klriutsa/ruson'
   spec.license     = 'MIT'
+  spec.required_ruby_version = '>= 2.5'
 
   spec.files         = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
@@ -25,7 +26,7 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'ffaker', '~> 2.13.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '>= 12.3.3'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'timecop', '~> 0.9.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruson
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.5
 platform: ruby
 authors:
 - klriutsa
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-12-03 00:00:00.000000000 Z
+date: 2021-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -56,16 +56,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,15 +94,17 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.1
-description: ruby json library.
+description: A Ruby serialization/deserialization library to convert Ruby Objects
+  into JSON and back
 email:
-- hiroya.kurushima@litalico.co.jp
+- kurushima.hiroya@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".ruby-version"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Dockerfile
@@ -114,6 +116,7 @@ files:
 - bin/setup
 - lib/ruson.rb
 - lib/ruson/base.rb
+- lib/ruson/class/array.rb
 - lib/ruson/class/boolean.rb
 - lib/ruson/class/float.rb
 - lib/ruson/class/integer.rb
@@ -139,15 +142,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubyforge_project: 
+rubygems_version: 2.7.3
 signing_key: 
 specification_version: 4
-summary: ruby json library.
+summary: A Ruby serialization/deserialization library to convert Ruby Objects into
+  JSON and back
 test_files: []