argumenta 0.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 70964aabded06f2363085ef1ce7620d8940a7215
+  data.tar.gz: 3af9f7935288a1eb391426e521baadbb23dd40af
+SHA512:
+  metadata.gz: 94bd56c3c0a2159fd0fbc215f975e6a3401f7604d0fbb679152b4d82afecfe6d9469e614b196ced5745291b8d7d91679df521332eee7fcd5455b428f00d7a22f
+  data.tar.gz: fd6c2ad24514da4d4eccbb48853e808844a8cd0ffca248e02b43feae39f48c80609cb78e52c9cd71f7f4682472cefe17f1b94116505da3a6143137c0479836c1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+gem 'dht', '>= 0.0.1'
+
+gemspec

data/Rakefile

@@ -0,0 +1,10 @@
+
+task :default => [:test]
+
+task :test do |t|
+  $LOAD_PATH.unshift 'lib', 'test'
+  files = Dir.glob './test/**/test*.rb'
+  files.each do |f|
+    require f
+  end
+end

data/argumenta.gemspec

@@ -0,0 +1,24 @@
+require './lib/argumenta/version'
+
+Gem::Specification.new do |s|
+  s.name        = "argumenta"
+  s.version     = Argumenta::VERSION
+  s.summary     = "Social argument collaboration ~ A Ruby implementation of Argumenta's core library."
+  s.description = ""
+  s.authors     = ["Tyler Florez"]
+  s.email       = ["qualiabyte@gmail.com"]
+  s.homepage    = "https://github.com/argumenta/argumenta"
+  s.license     = 'MIT'
+
+  s.files       = `git ls-files`.split($/)
+  s.executables = `git ls-files -- bin/*`.split($/).map { |f| File.basename(f) }
+  s.test_files  = `git ls-files -- {test,spec,features}/*`.split($/)
+
+  s.add_runtime_dependency "celluloid", "= 0.14.1"
+  s.add_runtime_dependency "celluloid-zmq", "= 0.14.0"
+  s.add_runtime_dependency "dcell", "= 0.14.0"
+  s.add_runtime_dependency "http", "= 0.4.0"
+  s.add_development_dependency "bundler", "~> 1.5"
+  s.add_development_dependency "minitest", "~> 4.7.5"
+  s.add_development_dependency "rake"
+end

data/lib/argumenta.rb

@@ -0,0 +1,19 @@
+require 'argumenta/objects'
+require 'argumenta/storage/dht'
+require 'argumenta/version'
+
+module Argumenta
+  include Argumenta::Objects
+
+  # Raised on failure to retrieve stored objects
+  class RetrievalError < Exception; end
+
+  # Raised for invalid objects during validation
+  class ValidationError < Exception; end
+
+  class App
+    def initialize
+      puts "Argumenta " + Argumenta::VERSION
+    end
+  end
+end

data/lib/argumenta/objects.rb

@@ -0,0 +1,7 @@
+require 'argumenta/objects/argument'
+require 'argumenta/objects/proposition'
+
+module Argumenta
+  module Objects
+  end
+end

data/lib/argumenta/objects/argument.rb

@@ -0,0 +1,50 @@
+require 'digest'
+
+module Argumenta
+  module Objects
+    # An argument includes a title, premises, and conclusion. It has an
+    # associated object record and SHA-1 hash. The object record is
+    # similar to Git's tree. The SHA-1 identifies the argument.
+    class Argument
+      attr_accessor :title, :premises, :conclusion
+
+      # Initializes a new argument.
+      #
+      #   title = "My Argument ^_^"
+      #   premises = [
+      #       "The first premise!",
+      #       "The second premise!"
+      #   ]
+      #   conclusion = "The conclusion."
+      #   argument = Argument.new title, premises, conclusion
+      #
+      def initialize(title, premises, conclusion)
+        @title = title
+        @premises = premises.map { |p| Proposition.new p }
+        @conclusion = Proposition.new conclusion
+      end
+
+      # Gets the argument's object record.
+      #
+      #   record = argument.record
+      #
+      def record
+        head = "argument\n\n"
+        body = "title #{@title}\n"
+        @premises.each do |p|
+          body += "premise #{p.sha1}\n"
+        end
+        body += "conclusion #{@conclusion.sha1}\n"
+        record = head + body
+      end
+
+      # Gets the argument's SHA-1.
+      #
+      #   sha1 = argument.sha1
+      #
+      def sha1
+        Digest::SHA1.hexdigest self.record
+      end
+    end
+  end
+end

data/lib/argumenta/objects/proposition.rb

@@ -0,0 +1,85 @@
+require 'digest'
+
+module Argumenta
+  module Objects
+    # A proposition models an assertion as a string of text. It has an
+    # associated object record and SHA-1 hash. The object record is
+    # similar to Git's blob. The SHA-1 identifies the proposition.
+    class Proposition
+      attr_accessor :text, :error
+
+      # Initializes a new proposition.
+      #
+      #   text = "My proposition!"
+      #   proposition = Proposition.new text
+      #
+      def initialize(text)
+        @text = text
+      end
+
+      # Gets the proposition's object record.
+      #
+      #   record = proposition.record
+      #
+      def record
+        "proposition " + @text
+      end
+
+      # Gets the proposition's SHA-1.
+      #
+      #   sha1 = proposition.sha1
+      #
+      def sha1
+        Digest::SHA1.hexdigest self.record
+      end
+
+      # Validates an object as a proposition.
+      #
+      #   valid = Proposition.validate object
+      #
+      # @raise [ValidationError] On failure.
+      def self.validate(object)
+        unless object.is_a? self
+          raise ValidationError "Object must be a proposition."
+        end
+        object.validate
+      end
+
+      # Validates the proposition.
+      #
+      #   begin
+      #     proposition.validate
+      #   rescue Argumenta::ValidationError => err
+      #     puts "Validation failed: ", err.message
+      #   end
+      #
+      # @raise [ValidationError] On validation failure.
+      def validate
+        unless @text.is_a? String
+          raise ValidationError, "Proposition text must be a string."
+        end
+        unless @text.length > 0 and text.match /\S+/
+          raise ValidationError, "Proposition text must not be empty."
+        end
+        unless @text.length <= 240
+          raise ValidationError, "Proposition text must be 240 characters or less."
+        end
+      end
+
+      # Checks whether proposition is valid.
+      #
+      #   valid = proposition.valid?
+      #
+      # @return [Boolean] The validation status.
+      def valid?
+        begin
+          self.validate
+          return true
+        rescue ValidationError => err
+          @error = err
+          return false
+        end
+      end
+    end
+  end
+end

data/lib/argumenta/storage/dht.rb

@@ -0,0 +1,28 @@
+require 'dht/hash'
+
+module Argumenta
+  module Storage
+    # A DHT data store for Argumenta objects.
+    class DHT
+      attr_accessor :hash
+
+      def initialize(options = {})
+        @hash = ::DHT::Hash.new options
+      end
+
+      def add_proposition(proposition)
+        Argumenta::Proposition.validate proposition
+        sha1 = proposition.sha1()
+        @hash[sha1] = proposition.text
+      end
+
+      def get_proposition(sha1)
+        text = @hash[sha1]
+        unless text
+          raise RetrievalError, "No proposition found for '#{sha1}'."
+        end
+        proposition = Argumenta::Proposition.new text
+      end
+    end
+  end
+end

data/lib/argumenta/version.rb

@@ -0,0 +1,3 @@
+module Argumenta
+  VERSION = '0.0.0'
+end

data/test/objects/test_argument.rb

@@ -0,0 +1,46 @@
+require 'argumenta'
+require 'test_helper'
+
+describe Argumenta::Argument do
+  before do
+    @title = "My Argument ^_^"
+    @premises = [
+      "The first premise!",
+      "The second premise!"
+    ]
+    @conclusion = "The conclusion."
+    @argument = Argumenta::Argument.new @title, @premises, @conclusion
+  end
+
+  describe "initialize" do
+    it "should create a new argument instance" do
+      @argument.must_be_instance_of Argumenta::Argument
+      @argument.title.must_equal "My Argument ^_^"
+      @argument.premises.length.must_equal 2
+      @argument.premises[0].text.must_equal "The first premise!"
+      @argument.premises[1].text.must_equal "The second premise!"
+      @argument.conclusion.text.must_equal "The conclusion."
+    end
+  end
+
+  describe "record" do
+    it "should get the argument's object record" do
+      record = @argument.record
+      record.must_equal <<-END.gsub(/^ +/, '')
+        argument
+
+        title My Argument ^_^
+        premise 37ca8beaaac1d1b8412c9fb1fd73e524c9862ebe
+        premise 29da59119a5c3cec4f7b339433e8931ea99771cf
+        conclusion 3940b2a6a3d5778297f0e37a06109f9d3dcffe6d
+      END
+    end
+  end
+
+  describe "sha1" do
+    it "should get the argument's SHA-1" do
+      sha1 = @argument.sha1
+      sha1.must_equal "50250211801dabf9cbf0e574af270ba2c3fe83cb"
+    end
+  end
+end

data/test/objects/test_proposition.rb

@@ -0,0 +1,52 @@
+require 'argumenta'
+require 'test_helper'
+
+describe Argumenta::Proposition do
+  before do
+    @text = "My proposition!"
+    @proposition = Argumenta::Proposition.new @text
+  end
+
+  describe "initialize" do
+    it "should create a new proposition instance" do
+      @proposition.must_be_instance_of Argumenta::Proposition
+      @proposition.text.must_equal "My proposition!"
+    end
+  end
+
+  describe "record" do
+    it "should get the proposition's object record" do
+      record = @proposition.record
+      record.must_equal "proposition My proposition!"
+    end
+  end
+
+  describe "sha1" do
+    it "should get the proposition's SHA-1" do
+      sha1 = @proposition.sha1
+      sha1.must_equal "fe1d2c8da97cd63ff28f9a1a3598fe29def216dd"
+    end
+  end
+
+  describe "valid?" do
+    it "should return true when valid" do
+      @proposition.valid?.must_equal true
+    end
+
+    it "should return false when not a string" do
+      proposition = Argumenta::Proposition.new 1
+      proposition.valid?.must_equal false
+    end
+
+    it "should return false when empty" do
+      proposition = Argumenta::Proposition.new ""
+      proposition.valid?.must_equal false
+    end
+
+    it "should return false when over max length" do
+      text = "a" * 241
+      proposition = Argumenta::Proposition.new text
+      proposition.valid?.must_equal false
+    end
+  end
+end

data/test/storage/test_dht.rb

@@ -0,0 +1,40 @@
+require 'argumenta'
+require 'test_helper'
+
+describe Argumenta::Storage::DHT do
+  options = {
+    host: "127.0.0.1",
+    port: 3033,
+    name: "test"
+  }
+  store = Argumenta::Storage::DHT.new options
+
+  before do
+    @store = store
+    @text = "My proposition!"
+    @proposition = Argumenta::Proposition.new @text
+  end
+
+  describe "initialize" do
+    it "should create a new dht storage instance" do
+      @store.must_be_instance_of Argumenta::Storage::DHT
+    end
+  end
+
+  describe "add_proposition" do
+    it "should add a proposition to the store" do
+      @store.add_proposition @proposition
+      retrieved = @store.get_proposition @proposition.sha1
+      retrieved.text.must_equal @proposition.text
+    end
+  end
+
+  describe "get_proposition" do
+    it "should get a proposition from the store by sha1" do
+      @store.add_proposition @proposition
+      sha1 = @proposition.sha1
+      retrieved = @store.get_proposition sha1
+      retrieved.text.must_equal @proposition.text
+    end
+  end
+end

data/test/test_argumenta.rb

@@ -0,0 +1,20 @@
+require 'argumenta'
+require 'test_helper'
+
+describe Argumenta do
+  it "should have a version string" do
+    Argumenta::VERSION.must_match /^\d+.\d+.\d+$/
+  end
+end
+
+describe Argumenta::App do
+  before do
+    @app = Argumenta::App.new
+  end
+
+  describe "initialize" do
+    it "should create a new argumenta instance" do
+      @app.must_be_instance_of Argumenta::App
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'celluloid'
+
+Celluloid.logger = ::Logger.new("test.log")

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: argumenta
+version: !ruby/object:Gem::Version
+  version: 0.0.0
+platform: ruby
+authors:
+- Tyler Florez
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.1
+- !ruby/object:Gem::Dependency
+  name: celluloid-zmq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: dcell
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.7.5
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- qualiabyte@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- argumenta.gemspec
+- lib/argumenta.rb
+- lib/argumenta/objects.rb
+- lib/argumenta/objects/argument.rb
+- lib/argumenta/objects/proposition.rb
+- lib/argumenta/storage/dht.rb
+- lib/argumenta/version.rb
+- test/objects/test_argument.rb
+- test/objects/test_proposition.rb
+- test/storage/test_dht.rb
+- test/test_argumenta.rb
+- test/test_helper.rb
+homepage: https://github.com/argumenta/argumenta
+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.0.3
+signing_key: 
+specification_version: 4
+summary: Social argument collaboration ~ A Ruby implementation of Argumenta's core
+  library.
+test_files: []