trailblazer 0.0.1 → 0.1.0

data/test/rails/fake_app/views/songs/new.html.erb

@@ -0,0 +1 @@
+<%= @form.errors.to_s %>

data/test/rails/test_helper.rb

@@ -0,0 +1,4 @@
+require 'trailblazer'
+require 'minitest/autorun'
+
+require 'fake_app/rails_app.rb'

data/test/responder_test.rb

@@ -0,0 +1,77 @@
+require 'test_helper'
+require 'trailblazer/operation/responder'
+
+class Song
+  extend ActiveModel::Naming
+
+  class Operation < Trailblazer::Operation
+    include CRUD
+    model Song
+    include Responder
+
+    def process(params)
+      invalid!(self) if params == false
+      self
+    end
+  end
+end
+
+module MyApp
+  class Song
+    extend ActiveModel::Naming
+
+    class Operation < Trailblazer::Operation
+      include CRUD
+      include Responder
+      model Song
+
+      def process(params)
+        invalid!(self) if params == false
+        self
+      end
+    end
+  end
+end
+
+class ResponderTestForModelWithoutNamespace < MiniTest::Spec
+
+  # test ::model_name
+  it { Song::Operation.model_name.name.must_equal "Song" }
+  it { Song::Operation.model_name.singular.must_equal "song" }
+  it { Song::Operation.model_name.plural.must_equal "songs" }
+  it { Song::Operation.model_name.element.must_equal "song" }
+  it { Song::Operation.model_name.human.must_equal "Song" }
+  it { Song::Operation.model_name.collection.must_equal "songs" }
+  it { Song::Operation.model_name.param_key.must_equal "song" }
+  it { Song::Operation.model_name.i18n_key.must_equal :"song" }
+  it { Song::Operation.model_name.route_key.must_equal "songs" }
+  it { Song::Operation.model_name.singular_route_key.must_equal "song" }
+
+  # #errors
+  it { Song::Operation[true].errors.must_equal [] }
+  it { Song::Operation[false].errors.must_equal [1] } # TODO: since we don't want responder to render anything, just return _one_ error. :)
+
+  # TODO: integration test with Controller.
+end
+
+
+class ResponderTestForModelWitNamespace < MiniTest::Spec
+
+    # test ::model_name
+    it { MyApp::Song::Operation.model_name.name.must_equal "MyApp::Song" }
+    it { MyApp::Song::Operation.model_name.singular.must_equal "my_app_song" }
+    it { MyApp::Song::Operation.model_name.plural.must_equal "my_app_songs" }
+    it { MyApp::Song::Operation.model_name.element.must_equal "song" }
+    it { MyApp::Song::Operation.model_name.human.must_equal "Song" }
+    it { MyApp::Song::Operation.model_name.collection.must_equal "my_app/songs" }
+    it { MyApp::Song::Operation.model_name.param_key.must_equal "my_app_song" } # "song" for AR.
+    it { MyApp::Song::Operation.model_name.i18n_key.must_equal :"my_app/song" }
+    it { MyApp::Song::Operation.model_name.route_key.must_equal "my_app_songs" } # "songs" for AR.
+    it { MyApp::Song::Operation.model_name.singular_route_key.must_equal "my_app_song" } # "song" for AR.
+
+    # #errors
+    it { MyApp::Song::Operation[true].errors.must_equal [] }
+    it { MyApp::Song::Operation[false].errors.must_equal [1] } # TODO: since we don't want responder to render anything, just return _one_ error. :)
+
+    # TODO: integration test with Controller.
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'trailblazer'
+require 'minitest/autorun'
+
+module TmpUploads
+  extend ActiveSupport::Concern
+
+  included do
+    let (:tmp_dir) { "/tmp/uploads" }
+    before { Dir.mkdir(tmp_dir) unless File.exists?(tmp_dir) }
+  end
+end
+
+MiniTest::Spec.class_eval do
+  include TmpUploads
+end

data/test/uploaded_file_test.rb

@@ -0,0 +1,85 @@
+require 'test_helper'
+require 'trailblazer/operation/uploaded_file'
+
+class TempfileTest < MiniTest::Spec
+
+end
+
+class UploadedFileTest < MiniTest::Spec
+  let (:image) { File.open("test/fixtures/apotomo.png") }
+  let (:tempfile) { tmp = Tempfile.new("bla")
+    tmp.write image.read
+    tmp
+   }
+
+  let (:upload) { ActionDispatch::Http::UploadedFile.new(
+    :tempfile => tempfile,
+    :filename => "apotomo.png",
+    :type     => "image/png")
+  }
+
+  describe "#to_hash" do
+    before {
+      @uploaded_path = upload.tempfile.path
+      @subject = Trailblazer::Operation::UploadedFile.new(upload).to_hash
+     }
+
+    it { @subject[:filename].must_equal "apotomo.png" }
+    it { @subject[:type].must_equal "image/png" }
+    it { @subject[:tempfile_path].must_match /\w+_trailblazer_upload$/ }
+
+
+    # Rails upload file must be removed.
+    it {
+      File.exists?(@uploaded_path).must_equal false }
+
+    it { File.exists?(@subject[:tempfile_path]).must_equal true }
+    it { File.size(@subject[:tempfile_path]).must_equal image.size }
+  end
+
+  describe "::from_hash" do
+    let (:data) { Trailblazer::Operation::UploadedFile.new(upload).to_hash }
+    subject { Trailblazer::Operation::UploadedFile.from_hash(data) }
+
+
+    it { subject.original_filename.must_equal "apotomo.png" }
+    it { subject.content_type.must_equal "image/png" }
+    it { subject.tempfile.must_be_kind_of File }
+    it { subject.size.must_equal image.size }
+
+    # params is not modified.
+    it { params = data.clone and subject; data.must_equal params }
+
+    # Tempfile must have proper extension for further processing (sidekiq/imagemagick, etc).
+    it { subject.tempfile.path.must_match /\.png$/ }
+
+    # Tempfile must be unlinked after process is finished.
+    it do
+      @subject = Trailblazer::Operation::UploadedFile.from_hash(data)
+
+      processable_file = @subject.tempfile.path
+      File.exists?(processable_file).must_equal true # this file must be GCed since it's a Tempfile, that's the whole point.
+      # @subject = nil
+      # GC.start
+      # File.exists?(processable_file).must_equal false
+    end
+  end
+
+
+  describe "with custom tmp directory" do
+    describe "#to_hash" do
+      before {
+        @uploaded = Trailblazer::Operation::UploadedFile.new(upload, :tmp_dir => tmp_dir)
+        @subject  = @uploaded.to_hash[:tempfile_path]
+      }
+
+      it { @subject.must_match /\w+_trailblazer_upload$/ }
+      it { @subject.must_match /^\/tmp\/uploads\// }
+
+      it { File.exists?(@subject).must_equal true }
+      it { File.size(@subject).must_equal image.size }
+
+      it { @uploaded.instance_variable_get(:@with_tmp_dir).path.must_equal nil }
+    end
+  end
+end

data/test/worker_test.rb

@@ -0,0 +1,116 @@
+# make sure #run always returns model
+
+# in test with sidekiq/testing
+# Operation.run #=> call perform_one and return [result, model] (model?)
+
+require 'test_helper'
+require 'trailblazer/operation'
+require 'trailblazer/operation/worker'
+require 'sidekiq/testing'
+
+
+class WorkerTest < MiniTest::Spec
+  class Operation < Trailblazer::Operation
+    include Worker
+
+    def run(params)
+      with_symbol = params[:title]
+      with_string = params["title"]
+      "I was working hard on #{params.inspect}. title:#{with_symbol} \"title\"=>#{with_string}"
+    end
+  end
+
+  class NoBackgroundOperation < Operation
+    def self.background?
+      false
+    end
+  end
+
+  # test basic worker functionality.
+  describe "with sidekiq" do
+    before { @res = Operation.run(:title => "Dragonfly") }
+
+    it { @res.kind_of?(String).must_equal true } # for now, we return the job from sidekiq.
+    it { Operation.jobs[0]["args"].must_equal([{"title"=>"Dragonfly"}]) }
+    it { Operation.perform_one.must_equal "I was working hard on {\"title\"=>\"Dragonfly\"}. title:Dragonfly \"title\"=>Dragonfly" }
+  end
+
+  # without sidekiq, we don't have indifferent_access automatically.
+  it { NoBackgroundOperation.run(:title => "Dragonfly").must_equal "I was working hard on {:title=>\"Dragonfly\"}. title:Dragonfly \"title\"=>" }
+
+
+  # test manual serialisation (to be done with UploadedFile etc automatically).
+  class SerializingOperation < Operation
+    include Worker
+
+    def self.serializable(params)
+      {:wrap => params}
+    end
+
+    def deserializable(params)
+      params[:wrap]
+    end
+  end
+
+  describe "with serialization in sidekiq" do
+    before { @res = SerializingOperation.run(:title => "Dragonfly") }
+
+    it { @res.kind_of?(String).must_equal true } # for now, we return the job from sidekiq.
+    it { SerializingOperation.jobs[0]["args"].must_equal([{"wrap"=>{"title"=>"Dragonfly"}}]) }
+    it { SerializingOperation.perform_one.must_equal "I was working hard on {\"title\"=>\"Dragonfly\"}. title:Dragonfly \"title\"=>Dragonfly" }
+  end
+end
+
+
+class WorkerFileMarshallerTest < MiniTest::Spec
+  def uploaded_file(name)
+    tmp = Tempfile.new("bla")
+    tmp.write File.open("test/fixtures/#{name}").read
+
+    ActionDispatch::Http::UploadedFile.new(
+    :tempfile => tmp,
+    :filename => name,
+    :type     => "image/png")
+  end
+
+  class Operation < Trailblazer::Operation
+    contract do
+      property :title
+      property :image, file: true
+
+      property :album do
+        property :image, file: true
+      end
+    end
+
+    include Worker
+    include Worker::FileMarshaller # should be ContractFileMarshaller
+
+    def process(params)
+      params
+    end
+  end
+
+  # TODO: no image
+
+  # with image serializes the file for later retrieval.
+  it do
+    Operation.run(title: "Dragonfly", image: uploaded_file("apotomo.png"), album: {image: uploaded_file("cells.png")})
+
+    args = Operation.jobs[0]["args"].first
+    args["title"].must_equal("Dragonfly")
+    args["image"]["filename"].must_equal "apotomo.png"
+    args["image"]["tempfile_path"].must_match /trailblazer_upload/
+
+    args["album"]["image"]["filename"].must_equal "cells.png"
+
+    _, params = Operation.perform_one # deserialize.
+
+    params["title"].must_equal("Dragonfly")
+    params[:title].must_equal("Dragonfly") # must allow indifferent_access.
+    params["image"].must_be_kind_of ActionDispatch::Http::UploadedFile
+    params["image"].original_filename.must_equal "apotomo.png"
+    params["album"]["image"].must_be_kind_of ActionDispatch::Http::UploadedFile
+    params["album"]["image"].original_filename.must_equal "cells.png"
+  end
+end

data/trailblazer.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Trailblazer::VERSION
   spec.authors       = ["Nick Sutterer"]
   spec.email         = ["apotonick@gmail.com"]
-  spec.description   = %q{A thin OOP framework on top of Rails that brings you form objects, view models, cells, decorators, representers, services and more.}
-  spec.summary       = %q{A thin OOP framework on top of Rails that brings you form objects, view models, cells, decorators, representers, services and more.}
+  spec.description   = %q{Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation, an intuitive code structure and gives you an object-oriented architecture.}
+  spec.summary       = %q{A New Architecture For Rails.}
   spec.homepage      = ""
   spec.license       = "MIT"
 
@@ -18,6 +18,14 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
+  spec.add_dependency "actionpack", '>= 3.0.0' # this framework works on Rails.
+  spec.add_dependency "uber", ">= 0.0.10" # no builder inheritance.
+  spec.add_dependency "representable", ">= 2.1.1", "<2.2.0" # Representable::apply.
+  spec.add_dependency "reform", "1.2.0.beta1"
+
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "minitest"
+  # spec.add_development_dependency "minitest-spec-rails" # TODO: can anyone make this work (test/rails).
+  spec.add_development_dependency "sidekiq", "~> 3.1.0"
 end

metadata

@@ -1,88 +1,225 @@
 --- !ruby/object:Gem::Specification
 name: trailblazer
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 0.1.0
 platform: ruby
 authors:
 - Nick Sutterer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-26 00:00:00.000000000 Z
+date: 2014-11-04 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: uber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.10
+- !ruby/object:Gem::Dependency
+  name: representable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.1.1
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+- !ruby/object:Gem::Dependency
+  name: reform
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0.beta1
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: A thin OOP framework on top of Rails that brings you form objects, view
-  models, cells, decorators, representers, services and more.
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: sidekiq
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.0
+description: Trailblazer is a thin layer on top of Rails. It gently enforces encapsulation,
+  an intuitive code structure and gives you an object-oriented architecture.
 email:
 - apotonick@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
+- ".travis.yml"
+- CHANGES.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- THOUGHTS
+- TODO.md
+- doc/Trb-The-Stack.png
+- doc/trb.jpg
+- gemfiles/Gemfile.rails
+- gemfiles/Gemfile.rails.lock
 - lib/trailblazer.rb
+- lib/trailblazer/autoloading.rb
+- lib/trailblazer/operation.rb
+- lib/trailblazer/operation/controller.rb
+- lib/trailblazer/operation/crud.rb
+- lib/trailblazer/operation/representer.rb
+- lib/trailblazer/operation/responder.rb
+- lib/trailblazer/operation/uploaded_file.rb
+- lib/trailblazer/operation/worker.rb
 - lib/trailblazer/version.rb
+- test/crud_test.rb
+- test/fixtures/apotomo.png
+- test/fixtures/cells.png
+- test/operation_test.rb
+- test/rails/controller_test.rb
+- test/rails/fake_app/app-cells/.gitkeep
+- test/rails/fake_app/cells.rb
+- test/rails/fake_app/config.rb
+- test/rails/fake_app/controllers.rb
+- test/rails/fake_app/models.rb
+- test/rails/fake_app/rails_app.rb
+- test/rails/fake_app/song/operations.rb
+- test/rails/fake_app/views/bands/show.html.erb
+- test/rails/fake_app/views/songs/new.html.erb
+- test/rails/test_helper.rb
+- test/responder_test.rb
+- test/test_helper.rb
+- test/uploaded_file_test.rb
+- test/worker_test.rb
 - trailblazer.gemspec
 homepage: ''
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.25
+rubygems_version: 2.2.2
 signing_key: 
-specification_version: 3
-summary: A thin OOP framework on top of Rails that brings you form objects, view models,
-  cells, decorators, representers, services and more.
-test_files: []
+specification_version: 4
+summary: A New Architecture For Rails.
+test_files:
+- test/crud_test.rb
+- test/fixtures/apotomo.png
+- test/fixtures/cells.png
+- test/operation_test.rb
+- test/rails/controller_test.rb
+- test/rails/fake_app/app-cells/.gitkeep
+- test/rails/fake_app/cells.rb
+- test/rails/fake_app/config.rb
+- test/rails/fake_app/controllers.rb
+- test/rails/fake_app/models.rb
+- test/rails/fake_app/rails_app.rb
+- test/rails/fake_app/song/operations.rb
+- test/rails/fake_app/views/bands/show.html.erb
+- test/rails/fake_app/views/songs/new.html.erb
+- test/rails/test_helper.rb
+- test/responder_test.rb
+- test/test_helper.rb
+- test/uploaded_file_test.rb
+- test/worker_test.rb