cat_engine 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 978fd55346645780b7553f8ee5f16efd85c23945
+  data.tar.gz: d2ab015f0efd6c4a625a287aa47dbe686a5ab693
+SHA512:
+  metadata.gz: fe2ac35c1da6745363a279f1773d7e7786e1bf042ddc7e07627b261783745b2efe61ff60181391f8b3e7f76ebfe83cadc95cd4e24c3a84287c8f5d56e23d8428
+  data.tar.gz: abfc555e330a6d84cae8d1c13db2db00fcf63dd684c1299138b3c295107ec5690880c27276146fddb4b6f33d288edb5df3f0696d639eb7de81f82cbaef926e8c

data/.gitignore

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

data/.rspec

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

data/.ruby-gemset

@@ -0,0 +1 @@
+cat_engine

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.2.3

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.2.0

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Micah Geisel
+
+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 @@
+# Cat Engine
+
+Ruby wrapper around C# Cat Engine
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cat_engine'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cat_engine
+
+## Usage
+
+You must compile the C# componetn before anything will work. There is a rake task for this. Requires `mcs` on Ubuntu.
+
+```bash
+rake compile_cat_engine`
+```
+
+See specs for more usage info
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+1. Fork it ( https://github.com/botandrose/cat_engine/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,11 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new
+
+desc "Compile the Cat Engine"
+task :compile_cat_engine do
+  require "cat_engine/engine"
+  CatEngine::Engine.compile
+end
+
+task :default => [:compile_cat_engine, :spec]

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cat_engine"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/cat_engine.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cat_engine/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cat_engine"
+  spec.version       = CatEngine::VERSION
+  spec.authors       = ["Micah Geisel"]
+  spec.email         = ["micah@botandrose.com"]
+
+  spec.summary       = %q{Ruby wrapper around C# Cat Engine}
+  spec.description   = %q{Ruby wrapper around C# Cat Engine}
+  spec.homepage      = "https://github.com/botandrose/cat_engine"
+  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_dependency "activemodel"
+  spec.add_dependency "nokogiri", "~> 1.0"
+  spec.add_dependency "memoist", "~> 0.14.0"
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "rspec-its", "~> 1.0"
+end

data/lib/cat_engine.rb

@@ -0,0 +1,11 @@
+require "cat_engine/version"
+require "cat_engine/config"
+require "cat_engine/rails" if defined?(Rails)
+require "cat_engine/bank"
+require "cat_engine/engine"
+require "cat_engine/question"
+require "cat_engine/response"
+require "cat_engine/flat_engine"
+
+module CatEngine
+end

data/lib/cat_engine/bank.rb

@@ -0,0 +1,57 @@
+require "cat_engine/engine"
+require "nokogiri"
+
+module CatEngine
+  class Bank < Struct.new(:id, :history, :full_history)
+    def paired?
+      id.include? "Illness Impact"
+    end
+
+    def name
+      xml.root["Name"]
+    end
+
+    def current_question
+      Question.new(xml: xml) unless finished?
+    end
+
+    def valid_answer?(response_id)
+      engine.valid_history?(id, [history, response_id].join(" "))
+    end
+
+    def finished?
+      xml.root.name == "Results"
+    end
+
+    def theta
+      return unless xml.root.key?("Theta")
+      (10 * xml.root["Theta"].to_f + 50).round
+    end
+
+    def standard_error
+      return unless xml.root.key?("StdError")
+      (10 * xml.root["StdError"].to_f).round
+    end
+
+    def to_h
+      {
+        finished: finished?,
+        theta: theta,
+        standard_error: standard_error,
+      }
+    end
+
+    alias_method :to_param, :id
+
+    private
+
+    def xml
+      engine.process(id, history)
+    end
+
+    def engine
+      id.include?(".flat") ? FlatEngine.new(full_history) : Engine.new
+    end
+  end
+end
+

data/lib/cat_engine/config.rb

@@ -0,0 +1,12 @@
+require "active_support/core_ext/module/attribute_accessors"
+
+module CatEngine
+  def self.configure
+    yield self
+  end
+
+  mattr_accessor(:cat_path) { "config/cat_engine" }
+  mattr_accessor(:cat_engine_source_path) { File.join(__dir__, "../../vendor/cat_engine") }
+  mattr_accessor(:cat_engine_executable_path) { File.expand_path("tmp/cat_engine.exe") }
+end
+

data/lib/cat_engine/engine.rb

@@ -0,0 +1,34 @@
+require "nokogiri"
+require "memoist"
+require "cat_engine/config"
+
+module CatEngine
+  class Engine
+    extend Memoist
+    class EngineError < StandardError; end
+
+    def self.compile
+      gmcs = [`which gmcs`.chomp, `which mcs`.chomp].find { |path| path != "" }
+      system "cd #{CatEngine.cat_engine_source_path} && #{gmcs} -debug -out:#{CatEngine.cat_engine_executable_path} *.cs"
+    end
+
+    def process id, history
+      command = %(cd #{CatEngine.cat_path} && mono --debug #{CatEngine.cat_engine_executable_path} "#{id}" #{history} 2>&1)
+      output = `#{command}`.chomp
+      if $?.success?
+        Nokogiri::XML.parse(output, nil, "utf-8")
+      else
+        raise EngineError.new(output)
+      end
+    end
+    memoize :process
+
+    def valid_history? id, history
+      process id, history
+      true
+    rescue EngineError => e
+      false
+    end
+  end
+end
+

data/lib/cat_engine/flat_engine.rb

@@ -0,0 +1,40 @@
+require "nokogiri"
+require "cat_engine/config"
+
+module CatEngine
+  class FlatEngine
+    def initialize full_history = []
+      self.full_history = full_history
+    end
+    attr_accessor :id, :full_history
+
+    def process id, history
+      self.id = id
+
+      doc = Nokogiri.parse(form)
+      item = doc.root.css("Item").reject do |item|
+        full_history.include?(item["FormItemOID"])
+      end.first
+
+      doc.root.children.each(&:unlink)
+      if item
+        item.parent = doc.root
+      else
+        doc.root = doc.create_element("Results")
+      end
+
+      doc
+    end
+
+    def valid_history? id, history
+      true
+    end
+
+    private
+
+    def form
+      File.read("#{CatEngine.cat_path}/forms/#{id}.xml")
+    end
+  end
+end
+

data/lib/cat_engine/question.rb

@@ -0,0 +1,83 @@
+require "nokogiri"
+require "active_model"
+
+module CatEngine
+  class Question < Struct.new(:id, :promis_id, :context, :title, :response_before, :responses)
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    def initialize attributes = nil
+      assign_attributes(attributes || {})
+    end
+
+    def context_and_title
+      [context, title].select(&:present?).join(" ")
+    end
+
+    def xml= xml
+      assign_attributes XMLMapper.new(xml).to_h
+    end
+
+    def persisted?; false; end
+
+    attr_accessor :responses_attributes, :selected_response_index, :response
+
+    def selected_response
+      if selected_response_index
+        responses_attributes[selected_response_index]
+      else
+        { id: "00000000-0000-0000-0000-000000000000", title: response || "Skipped" }
+      end
+    end
+
+    private
+
+    def assign_attributes attributes
+      attributes.each do |key, value|
+        send :"#{key}=", value
+      end
+    end
+
+    class XMLMapper < Struct.new(:xml)
+      def id
+        xml.xpath("//Item")[0]["FormItemOID"]
+      end
+
+      def promis_id
+        xml.xpath("//Item")[0]["ID"]
+      end
+
+      def context
+        element_descriptions[0]
+      end
+
+      def title
+        element_descriptions[1]
+      end
+
+      def responses
+        xml.xpath("//Map").map do |xml|
+          Response.new(xml: xml)
+        end
+      end
+
+      def to_h
+        {
+          id: id,
+          promis_id: promis_id,
+          context: context,
+          title: title,
+          responses: responses,
+        }
+      end
+
+      private
+
+      def element_descriptions
+        elements = xml.xpath("//Element")[0..-2] # drop last container element
+        elements.map { |e| e["Description"] } # sometimes one, sometimes two
+      end
+    end
+  end
+end
+

data/lib/cat_engine/rails.rb

@@ -0,0 +1,7 @@
+module CatEngine
+  class Rails < ::Rails::Railtie
+    rake_tasks do
+      load File.join(__dir__, "../tasks/cat_engine_tasks.rake")
+    end
+  end
+end

data/lib/cat_engine/response.rb

@@ -0,0 +1,50 @@
+require "nokogiri"
+require "active_model"
+
+module CatEngine
+  class Response < Struct.new(:id, :promis_id, :before, :title)
+    include ActiveModel::Conversion
+    extend ActiveModel::Naming
+
+    def initialize attributes = nil
+      assign_attributes(attributes || {})
+    end
+
+    def xml= xml
+      assign_attributes XMLMapper.new(xml).to_h
+    end
+
+    def persisted?; false; end
+
+    private
+
+    def assign_attributes attributes
+      attributes.each do |key, value|
+        send :"#{key}=", value
+      end
+    end
+
+    class XMLMapper < Struct.new(:xml)
+      def id
+        xml["ItemResponseOID"]
+      end
+
+      def promis_id
+        xml["Value"]
+      end
+
+      def title
+        xml["Description"]
+      end
+
+      def to_h
+        {
+          id: id,
+          promis_id: promis_id,
+          title: title,
+        }
+      end
+    end
+  end
+end
+