inch_ci-worker 0.3.0.rc9 → 0.3.0.rc10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9874381709670f0694023c6388e915586b2926b1
-  data.tar.gz: c6b310dd4e3742969c7fc0f7e9fe8138023faccb
+  metadata.gz: f72a4bd2a458223d6c2faa1b7ac7ba798e7e6831
+  data.tar.gz: d779cbb0aae588155af3c2020c50f79088b2f426
 SHA512:
-  metadata.gz: 48d24e7beda00884940b87d2a01a3b85bfb4bb1eb3b3cda9109729d5035d19ba5391c75e5730077acf5e8d249bcf7239095066cee9cc92038d2c6d5ca2927a85
-  data.tar.gz: 5392b0cc367aa3c1e091c7878b93172f046c22abfabdd9fce03dd0a41b406596d3efd6c2fee684e3cea347a6c5b7b8106d3c6689dc6c52b97986c43af5d5b019
+  metadata.gz: 9042d311469257e18c7b8cee67d7f8746aa9ecbca964622d77eed9e2a47ea77841ae485413e5191a4d2fa5d9d77b982695fd72fade73f86e76477f9b61faa5c3
+  data.tar.gz: 42b1b1afe829ec4de335830d6033704227f45db8a4c974f8b95c78f3ee948d605fc4f046fdbc7b37a90d1ff53416931d77874c9dac05d71faccb03821e06f279

data/bin/inch_ci-worker

@@ -21,6 +21,12 @@ class Command
     end
   end
 
+  class BuildJSON
+    def initialize(filename)
+      InchCI::Worker::BuildJSON::Task.new(filename)
+    end
+  end
+
   class ListTags
     def initialize(url, branch_name)
       InchCI::Worker::ListTags::Task.new(url, branch_name)
@@ -35,6 +41,7 @@ class Command
 
   MAP = {
     'build' => Build,
+    'build-from-json' => BuildJSON,
     'list-tags' => ListTags,
     '-v' => Version,
   }

data/lib/inch_ci/worker/build.rb

@@ -1,4 +1,4 @@
-require_relative 'build/task'
+require 'inch_ci/worker/build/task'
 
 module InchCI
   module Worker

data/lib/inch_ci/worker/build_json/task.rb

@@ -0,0 +1,88 @@
+require 'json'
+require 'inch'
+require 'inch/cli'
+
+module InchCI
+  module Worker
+    module BuildJSON
+      class Task
+        attr_reader :json
+
+        def initialize(filename)
+          @json = JSON[File.read(filename)]
+          @work_dir = Dir.mktmpdir
+
+          started_at = Time.now
+          @result = build(filename)
+          @result.finished_at = Time.now
+          @result.started_at = started_at
+          puts Build::Report.new(@result).to_yaml
+        end
+
+        private
+
+        # @param info [#service_name,#user_name,#repo_name]
+        def badge_in_readme?(info)
+          Build::BadgeDetector.in_readme?(repo, info)
+        end
+
+        def build(filename)
+          language    = json['language']
+          branch_name = json['branch_name'] || json['travis_branch']
+          revision    = json['revision'] || json['travis_commit']
+          nwo         = json['nwo'] || json['travis_repo_slug']
+          @url        = json['git_repo_url']
+          latest_revision  = true # TODO: make truthful
+
+          if retrieve_repo
+            if repo.change_branch(branch_name, true)
+              if repo.checkout_revision(revision)
+                if @codebase = parse_codebase(language, filename, repo.path)
+                  result = Build::ResultSuccess.new(repo, branch_name, latest_revision, @codebase.objects)
+                  result.badge_in_readme = badge_in_readme?(result)
+                  result
+                else
+                  Build::ResultParserFailed.new(repo, branch_name, latest_revision, nil)
+                end
+              else
+                Build::ResultCheckoutRevisionFailed.new(repo, branch_name, latest_revision, nil)
+              end
+            else
+              Build::ResultChangeBranchFailed.new(repo, branch_name, latest_revision, nil)
+            end
+          else
+            Build::ResultRetrieverFailed.new(repo, branch_name, latest_revision, nil)
+          end
+        end
+
+        def parse_codebase(language, filename, path)
+          begin
+            ::Inch::Codebase.parse(path, to_config(language, filename, path))
+          rescue Exception => e
+            warn e.inspect
+            nil
+          end
+        end
+
+        def repo
+          @repo ||= Repomen::Retriever.new(@url, :work_dir => @work_dir)
+        end
+
+        # @return [Repomen::Retriever,nil] either the retrieved repo or +nil+
+        def retrieve_repo
+          repo.retrieved? ? repo : nil
+        end
+
+        # Creates a Config::Codebase object and returns it
+        # (merges relevant values of a given +options+ object before).
+        #
+        # @return [Config::Codebase]
+        def to_config(language, filename, path)
+          config = ::Inch::Config.for(language, path).codebase
+          config.read_dump_file = filename
+          config
+        end
+      end
+    end
+  end
+end

data/lib/inch_ci/worker/build_json.rb

@@ -0,0 +1,8 @@
+require 'inch_ci/worker/build_json/task'
+
+module InchCI
+  module Worker
+    module BuildJSON
+    end
+  end
+end

data/lib/inch_ci/worker/list_tags/task.rb

@@ -1,7 +1,7 @@
 require 'inch'
 require 'repomen'
 
-require_relative 'report'
+require 'inch_ci/worker/list_tags/report'
 
 module InchCI
   module Worker

data/lib/inch_ci/worker/list_tags.rb

@@ -1,4 +1,4 @@
-require_relative 'list_tags/task'
+require 'inch_ci/worker/list_tags/task'
 
 module InchCI
   module Worker

data/lib/inch_ci/worker/version.rb

@@ -1,5 +1,5 @@
 module InchCI
   module Worker
-    VERSION = "0.3.0.rc9"
+    VERSION = "0.3.0.rc10"
   end
 end

data/lib/inch_ci/worker.rb

@@ -12,4 +12,5 @@ module InchCI
 end
 
 require 'inch_ci/worker/build'
+require 'inch_ci/worker/build_json'
 require 'inch_ci/worker/list_tags'

data/test/fixtures/elixir/inch_ex.json

@@ -0,0 +1 @@
+{"travis_branch":"master","travis_repo_slug":"rrrene/inch_ex","travis_commit":null,"travis_job_id":null,"travis":true,"git_repo_url":"git@github.com:rrrene/inch_ex.git","language":"elixir","args":[],"objects":[{"object_type":"ModuleObject","id":"InchEx","module":"Elixir.InchEx","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Config","module":"Elixir.InchEx.Config","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Docs.Formatter","module":"Elixir.InchEx.Docs.Formatter","moduledoc":"Provide JSON-formatted documentation\n","source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Docs.Retriever","module":"Elixir.InchEx.Docs.Retriever","moduledoc":"Functions to extract documentation information from modules.\n","source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Docs.Retriever.Error","module":"Elixir.InchEx.Docs.Retriever.Error","moduledoc":null,"source":null,"type":"exception","typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.FunctionObject","module":"Elixir.InchEx.FunctionObject","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.ModuleObject","module":"Elixir.InchEx.ModuleObject","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Reporter.Local","module":"Elixir.InchEx.Reporter.Local","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.Reporter.Remote","module":"Elixir.InchEx.Reporter.Remote","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"InchEx.TypeObject","module":"Elixir.InchEx.TypeObject","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"Mix.Tasks.Inch","module":"Elixir.Mix.Tasks.Inch","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"ModuleObject","id":"Mix.Tasks.Inch.Report","module":"Elixir.Mix.Tasks.Inch.Report","moduledoc":null,"source":null,"type":null,"typespecs":[]},{"object_type":"FunctionObject","module_id":"InchEx","arity":4,"doc":false,"id":"generate_docs/4","name":"generate_docs","signature":[["project",[],null],["version",[],null],["args",[],null],["options",[],null]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Formatter","arity":3,"doc":"Generate JSON documentation for the given modules\n","id":"run/3","name":"run","signature":[["modules",[],null],["args",[],null],["config",[],null]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Retriever","arity":2,"doc":"Extract documentation from all modules in the specified directory\n","id":"docs_from_dir/2","name":"docs_from_dir","signature":[["dir",[],null],["config",[],null]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Retriever","arity":2,"doc":"Extract documentation from all modules in the specified list of files\n","id":"docs_from_files/2","name":"docs_from_files","signature":[["files",[],null],["config",[],null]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Retriever","arity":2,"doc":"Extract documentation from all modules in the list `modules`\n","id":"docs_from_modules/2","name":"docs_from_modules","signature":[["modules",[],null],["config",[],null]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Retriever.Error","arity":1,"doc":"Callback implementation of `Exception.exception/1`.","id":"exception/1","name":"exception","signature":[["args",[],null]],"source":null,"specs":[["::",{"line":19},[["exception",{"line":19},[[[".",{"line":19},["Elixir.Keyword","t"]],{"line":19},[]]]],[[".",{"line":19},["Elixir.Exception","t"]],{"line":19},[]]]]],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Docs.Retriever.Error","arity":1,"doc":"Callback implementation of `Exception.message/1`.","id":"message/1","name":"message","signature":[["exception",[],null]],"source":null,"specs":[["::",{"line":19},[["message",{"line":19},[[[".",{"line":19},["Elixir.Exception","t"]],{"line":19},[]]]],[[".",{"line":19},["Elixir.String","t"]],{"line":19},[]]]]],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Reporter.Local","arity":2,"doc":"  Runs inch locally, if installed. If you want to force usage of a particular\n  inch installation, set INCH_PATH environment variable:\n\n    export INCH_PATH=/home/rrrene/projects/inch\n\n  Otherwise, InchEx will take whatever `inch` command it finds. If it does\n  not find any, it sends the data to the open API at inch-ci.org (or the\n  endpoint defined in the INCH_CLI_API environment variable) to perform\n  the analysis and reports the findings back.\n","id":"run/2","name":"run","signature":[["filename",[],null],["\\\\",[],[["args",[],null],[]]]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"InchEx.Reporter.Remote","arity":2,"doc":"  Runs inch remotely, if already invented.\n","id":"run/2","name":"run","signature":[["filename",[],null],["",[],"Elixir"]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"Mix.Tasks.Inch","arity":4,"doc":false,"id":"run/4","name":"run","signature":[["args",[],null],["\\\\",[],[["config",[],null],[[".",{"line":10},["Elixir.Mix.Project","config"]],{"line":10},[]]]],["\\\\",[],[["generator",[],null],[[".",[],["erlang","make_fun"]],{"line":10},["Elixir.InchEx","generate_docs",4]]]],["\\\\",[],[["reporter",[],null],"Elixir.InchEx.Reporter.Local"]]],"source":null,"specs":[],"type":"def"},{"object_type":"FunctionObject","module_id":"Mix.Tasks.Inch.Report","arity":4,"doc":false,"id":"run/4","name":"run","signature":[["",[],"Elixir"],["\\\\",[],[["config",[],null],[[".",{"line":8},["Elixir.Mix.Project","config"]],{"line":8},[]]]],["\\\\",[],[["generator",[],null],[[".",[],["erlang","make_fun"]],{"line":8},["Elixir.InchEx","generate_docs",4]]]],["\\\\",[],[["reporter",[],null],"Elixir.InchEx.Reporter.Remote"]]],"source":null,"specs":[],"type":"def"}]}

data/test/integration/build_json_test.rb

@@ -0,0 +1,19 @@
+require File.expand_path(File.dirname(__FILE__) + '/../test_helper')
+
+describe ::InchCI::Worker::BuildJSON do
+  let(:described_class) { ::InchCI::Worker::BuildJSON::Task }
+  let(:filename) { File.expand_path(File.dirname(__FILE__) + '/../fixtures/elixir/inch_ex.json') }
+
+  #
+  # Good scenarios
+  #
+
+  it 'should retrieve the repo' do
+    out, err = capture_io do
+      @task = described_class.new(filename)
+    end
+    refute out.empty?
+    assert_match /status: success/, out
+    assert err.empty?
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: inch_ci-worker
 version: !ruby/object:Gem::Version
-  version: 0.3.0.rc9
+  version: 0.3.0.rc10
 platform: ruby
 authors:
 - René Föhring
@@ -117,11 +117,15 @@ files:
 - lib/inch_ci/worker/build/report.rb
 - lib/inch_ci/worker/build/result.rb
 - lib/inch_ci/worker/build/task.rb
+- lib/inch_ci/worker/build_json.rb
+- lib/inch_ci/worker/build_json/task.rb
 - lib/inch_ci/worker/list_tags.rb
 - lib/inch_ci/worker/list_tags/report.rb
 - lib/inch_ci/worker/list_tags/task.rb
 - lib/inch_ci/worker/version.rb
+- test/fixtures/elixir/inch_ex.json
 - test/integration/badge_detector_test.rb
+- test/integration/build_json_test.rb
 - test/integration/build_test.rb
 - test/integration/inch_version_test.rb
 - test/test_helper.rb
@@ -151,7 +155,9 @@ signing_key:
 specification_version: 4
 summary: Worker for the Inch CI project
 test_files:
+- test/fixtures/elixir/inch_ex.json
 - test/integration/badge_detector_test.rb
+- test/integration/build_json_test.rb
 - test/integration/build_test.rb
 - test/integration/inch_version_test.rb
 - test/test_helper.rb