ceres 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b38b7e2d8628453da7be0e2aae9a4340ec930fd90b753a5c2abf943e73baa8d3
+  data.tar.gz: 934797928e8f06b68e0f244708ae5ad920273ac5cbcf45f81a5e56c8ec3cb727
+SHA512:
+  metadata.gz: 4a4051ef093dda714bcb676dda3ff6408a2e998aa24c720a4b58721e72bbc52dd6a215ac43fd4bd0cdca7f22bf44876cfe715042f480ce972a9828acbf990460
+  data.tar.gz: a406a97bda949cb9e44e851125f71aa9ad9b728a08809afd6093be836c4b85ff107bf8a20ca30ff008885d838d2940fbcde7c54281a9c2c2b09f57447111b419

data/.gitignore

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

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,80 @@
+AllCops:
+  DisplayCopNames: true
+  TargetRubyVersion: 2.2
+
+Lint/AssignmentInCondition:
+  AllowSafeAssignment: false
+
+Lint/BlockAlignment:
+  AlignWith: start_of_line
+
+Lint/EndAlignment:
+  AlignWith: variable
+
+Metrics/LineLength:
+  Max: 100
+
+Metrics/MethodLength: 
+  Max: 20
+
+Metrics/ParameterLists:
+  Max: 10
+
+Style/CaseIndentation:
+  IndentWhenRelativeTo: end
+
+Metrics/ClassLength:
+  Max: 1500
+
+Style/CollectionMethods:
+  Enabled: true
+
+# TODO: This should be enabled
+Style/Documentation:
+  Enabled: false
+
+Style/ElseAlignment:
+  Enabled: false
+
+Style/FormatString:
+  EnforcedStyle: percent
+
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# I like this in theory, but sometimes it weirds out
+Style/GuardClause:
+  Enabled: false
+
+Style/HashSyntax:
+  EnforcedStyle: ruby19_no_mixed_keys
+
+Style/MultilineOperationIndentation:
+  Enabled: false
+
+Style/ParenthesesAroundCondition:
+  AllowSafeAssignment: false
+
+Style/RaiseArgs:
+  Enabled: false
+
+Style/RedundantReturn:
+  Enabled: false
+
+Style/RedundantSelf:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/SignalException:
+  EnforcedStyle: only_raise
+
+Style/SpaceAroundEqualsInParameterDefault:
+  EnforcedStyle: space
+  
+Style/SpaceInsideRangeLiteral:
+  Enabled: false
+
+Style/SymbolArray:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,18 @@
+sudo: false
+language: ruby
+cache: bundler
+
+before_install: gem install bundler -v 1.13.1
+bundler_args: --jobs=3 --retry=3
+
+rvm:
+  - 2.2.5
+  - 2.3.1
+  - ruby-head
+  - jruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+
+  fast_finish: true

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "rake"
+  gem "rspec"
+  gem "rubocop"
+  gem "simplecov"
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Ceres contributors
+
+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,43 @@
+# Ceres #
+
+[![Build Status](https://travis-ci.org/aventine-softworks/ceres.svg?branch=master)](https://travis-ci.org/aventine-softworks/ceres)
+
+Ceres is a gem that extends the Ruby standard library with some cool new features, but it doesn't monkey patch anything or break anything you already have, so just require what you want or go all in with `require 'ceres'`. The main features are mostly immutable type safe classes, synchronized objects, notification centers, and thread pools.
+
+The main goal is to allow sloppy people like me write good code by catching errors instead of just silently letting them slip.
+
+
+## Installation ##
+
+If you're using bundler you can just add this line to your application's Gemfile:
+
+```ruby
+gem 'ceres'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ceres
+
+
+## Development ##
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+
+## License ##
+
+Ceres is released under the MIT license:
+
+www.opensource.org/licenses/MIT
+
+
+## Contributing ##
+
+Bug reports (and pull requests) are appreciated on GitHub at https://github.com/rawrasaur/ceres, I'm sorry if I'm slow at responding.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "safe_structure"
+
+# 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,6 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install

data/ceres.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require "ceres/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ceres"
+  spec.version = Ceres::VERSION
+  spec.authors = ["Aurora"]
+  spec.email = ["aurora@aventine.se"]
+
+  spec.summary = " A collection of useful things"
+  spec.homepage = "https://github.com/rawrasaur/ceres"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+end

data/lib/ceres/attribute.rb

@@ -0,0 +1,74 @@
+require "ceres/reader"
+require "ceres/writer"
+require "ceres/inspector"
+
+module Ceres
+  class Attribute
+    attr_reader :name
+
+    attr_accessor :description
+    attr_accessor :variable
+    attr_accessor :target
+    attr_accessor :reader
+    attr_accessor :writer
+    attr_accessor :inspector
+
+    class DSL
+      def initialize(object, &block)
+        @object = object
+
+        self.instance_exec(&block) if block
+      end
+
+      def description(text)
+        @object.description = text
+      end
+
+      def target(symbol)
+        @object.target = symbol
+      end
+
+      def variable(symbol)
+        @object.variable = symbol
+      end
+
+      def reader(disabled: false, **args, &block)
+        reader = Ceres::Reader.new(@object, **args, &block) unless disabled
+
+        @object.reader = reader
+      end
+
+      def writer(disabled: false, &block)
+        writer = Ceres::Writer.new(@object, &block) unless disabled
+
+        @object.writer = writer
+      end
+
+      def inspector(disabled: false, &block)
+        inspector = Ceres::Inspector.new(&block) unless disabled
+
+        @object.inspector = inspector
+      end
+    end
+
+    def initialize(name, &block)
+      @name = name.to_sym
+
+      @description = nil
+      @variable = "@#{name}".to_sym
+
+      @reader = Ceres::Reader.new(self)
+      @writer = nil
+      @inspector = Ceres::Inspector.new
+
+      Ceres::Attribute::DSL.new(self, &block)
+    end
+
+    def apply(klass)
+      @reader.apply(klass) if @reader
+      @writer.apply(klass) if @writer
+
+      klass
+    end
+  end
+end

data/lib/ceres/inspector.rb

@@ -0,0 +1,17 @@
+module Ceres
+  class Inspector
+    def initialize(&block)
+      @block = block
+    end
+
+    def inspect_object(object)
+      if @block
+        @block.call(object)
+      else
+        object
+      end.inspect
+    rescue => e
+      "<EXCEPTION RAISED IN INSPECT: #{e.inspect}>"
+    end
+  end
+end

data/lib/ceres/object.rb

@@ -0,0 +1,44 @@
+require "ceres/attribute"
+
+module Ceres
+  class Object
+    def self.inherited(klass)
+      klass.instance_exec { @attributes = [] }
+    end
+
+    def self.attribute(name, &block)
+      attribute = Ceres::Attribute.new(name, &block)
+      attribute.apply(self)
+
+      @attributes << attribute
+    end
+
+    def self.attributes(all: true)
+      if all
+        self.ancestors.flat_map do |ancestor|
+          if ancestor.respond_to?(:attributes)
+            ancestor.attributes(all: false)
+          else
+            []
+          end
+        end
+      elsif defined?(@attributes)
+        @attributes
+      else
+        []
+      end
+    end
+
+    def inspect
+      attributes = self.class.attributes.map do |attribute|
+        if attribute.inspector
+          name = attribute.name
+
+          " #{name}: #{attribute.inspector.inspect_object(self.send(name))}"
+        end
+      end.compact.join(",")
+
+      sprintf("#<%p:%0#18x%s>", self.class, self.object_id << 1, attributes)
+    end
+  end
+end

data/lib/ceres/reader.rb

@@ -0,0 +1,77 @@
+module Ceres
+  class Reader
+    attr_reader :attribute
+    attr_reader :block
+
+    def initialize(attribute, cache: false, &block)
+      @attribute = attribute
+      @cache = cache
+      @block = block
+    end
+
+    def cache?
+      @cache
+    end
+
+    def name
+      @attribute.name
+    end
+
+    def target
+      @attribute.target
+    end
+
+    def variable
+      @attribute.variable
+    end
+
+    def to_proc
+      self.cache? ? to_cached_proc : to_uncached_proc
+    end
+
+    def apply(klass)
+      name = self.name
+
+      if allow_reader_optimisation?
+        klass.instance_exec { attr_reader name }
+      else
+        reader = self.to_proc
+
+        klass.instance_exec { define_method(name, &reader) }
+      end
+    end
+
+    private def allow_reader_optimisation?
+      !@block && self.target.nil? && self.variable == "@#{self.name}".to_sym
+    end
+
+    private def to_uncached_proc
+      target = self.target
+      variable = self.variable
+      block = self.block
+
+      if target
+        if block
+          proc { instance_variable_get(target).instance_exec(&block) }
+        else
+          proc { instance_variable_get(target).instance_variable_get(variable) }
+        end
+      else
+        block || proc { instance_variable_get(variable) }
+      end
+    end
+
+    private def to_cached_proc
+      uncached_proc = to_uncached_proc
+      variable = self.variable
+
+      proc do
+        if instance_variable_defined?(variable)
+          instance_variable_get(variable)
+        else
+          instance_variable_set(variable, instance_exec(&uncached_proc))
+        end
+      end
+    end
+  end
+end

data/lib/ceres/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ceres
+  VERSION = "0.2.0".freeze
+end

data/lib/ceres/writer.rb

@@ -0,0 +1,63 @@
+module Ceres
+  class Writer
+    attr_reader :attribute
+    attr_reader :block
+
+    def initialize(attribute, &block)
+      @attribute = attribute
+      @block = block
+    end
+
+    def name
+      @attribute.name
+    end
+
+    def target
+      @attribute.target
+    end
+
+    def variable
+      @attribute.variable
+    end
+
+    def to_proc
+      target = self.target
+      variable = self.variable
+      block = self.block
+
+      if target
+        if block
+          proc do |v|
+            t = instance_variable_get(target)
+            t.instance_variable_set(variable, t.instance_exec(v, &block))
+          end
+        else
+          proc { |v| instance_variable_get(target).instance_variable_set(variable, v) }
+        end
+      else
+        if block
+          proc { |v| instance_variable_set(variable, instance_exec(v, &block)) }
+        else
+          proc { |v| instance_variable_set(variable, v) }
+        end
+      end
+    end
+
+    def apply(klass)
+      if allow_writer_optimisation?
+        name = self.name
+
+        klass.instance_exec { attr_writer name }
+      else
+        name = "#{@attribute.name}=".to_sym
+        writer = self.to_proc
+
+        klass.instance_exec { define_method(name, &writer) }
+      end
+    end
+
+    private def allow_writer_optimisation?
+      !@block && self.target.nil? && self.variable == "@#{@attribute.name}".to_sym
+    end
+  end
+end

data/lib/ceres.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "ceres/version"
+
+require "ceres/attribute"
+require "ceres/object"
+require "ceres/reader"
+require "ceres/writer"
+

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: ceres
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Aurora
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-20 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- aurora@aventine.se
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- ceres.gemspec
+- lib/ceres.rb
+- lib/ceres/attribute.rb
+- lib/ceres/inspector.rb
+- lib/ceres/object.rb
+- lib/ceres/reader.rb
+- lib/ceres/version.rb
+- lib/ceres/writer.rb
+homepage: https://github.com/rawrasaur/ceres
+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.7.6
+signing_key: 
+specification_version: 4
+summary: A collection of useful things
+test_files: []