xcskarel 0.7.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9989b96aa6ff52cf3fc52a82ec381ba4410d62f4
-  data.tar.gz: cd7fff217976a40c5405f96daf2ff3f043f5a77e
+  metadata.gz: b2d2ee90682d97c41330da69045be0e7d247e205
+  data.tar.gz: 64564df685430fb56aa6af4e47a402f9fd2e4022
 SHA512:
-  metadata.gz: d32ad6a22b710bd163c14a188b4ff804bba907808204efe46fba78867979f86f9918c86307bb2831c9e82504d2f065848645d869fe4fcb256c9d76cf22b12bd9
-  data.tar.gz: 35443b16521422e86b5f183a22c6ba1689385bf265e3dc13c0e4e096f72de0f20779cacf89e14e4b53b52f280b3cb1dfde6d155ad6d353de2761f42af1ad3aa5
+  metadata.gz: 0845f1c391fda33d0e758c4ff1cf742ca63aed8ac2d8a311ca7554ed37b99d51ad6852c1875ab82d4099a066367ae5a5ced67b789b472e483ec9ca833bac9501
+  data.tar.gz: df228a2c1a18993371002d6868a8baedac53425c234894a622c1287c53276ac1ba09381d648bb8225063cc9a22baf28aa5299767bc563184e3ce66d5b2d603b3

data/bin/xcskarel

@@ -33,6 +33,52 @@ class XCSKarelApplication
     global_option('--no_pretty', 'Disables output JSON prettification')
     global_option('--no_filter', 'Prints full JSON payload for objects instead of just filtering the important ones')
 
+    # Managing local xcsconfig folder
+
+    command :'config list' do |c|
+      c.syntax = 'xcskarel config list [options]'
+      c.description = 'Lists the Xcode Bot configurations found in this folder'
+      c.example 'lists all configurations stored in this folder', 'xcskarel config list'
+      c.action do |args, options|
+        config_folder = XCSKarel::XCSFile.get_config_folder
+        return unless config_folder
+        XCSKarel::Application.list_configs(config_folder)
+      end
+    end
+
+    command :'config show' do |c|
+      c.syntax = 'xcskarel config show [options]'
+      c.description = 'Opens the selected config for editing'
+      c.example 'opens a config of choice', 'xcskarel config show'
+      c.action do |args, options|
+        config_folder = XCSKarel::XCSFile.get_config_folder
+        return unless config_folder
+        XCSKarel::Application.show_config(config_folder)
+      end
+    end
+
+    command :'config new' do |c|
+      c.syntax = 'xcskarel config new [options]'
+      c.description = 'Starts the interactive process of creating a new config from an existing Bot'
+      c.example 'starts creating new config from server at 192.168.1.64', 'xcskarel config new --host 192.168.1.64'
+      add_xcs_options(c)
+      c.action do |args, options|
+        
+        # let user chose a bot from the server
+        server = create_server_from_options(options)
+        bot = XCSKarel::Application.choose_bot(server)
+
+        # get our config folder
+        config_folder = XCSKarel::XCSFile.get_config_folder
+        return unless config_folder
+
+        # dump the bot into that config folder under a random name
+        XCSKarel::Application.save_bot(config_folder, bot, server.api_version)
+      end
+    end
+
+    # Talking to Xcode Server API
+
     command :bots do |c|
       c.syntax = 'xcskarel bots [options]'
       c.description = 'Fetches all Bots found on the specified server'
@@ -87,6 +133,8 @@ class XCSKarelApplication
       end
     end
 
+    # Managing a local Xcode Server
+
     command :'server start' do |c|
       c.syntax = 'xcskarel server start [options]'
       c.description = 'Start local Xcode Server'
@@ -137,6 +185,8 @@ class XCSKarelApplication
       end
     end
 
+    # Managing Xcode
+
     command :'xcode select' do |c|
       c.syntax = 'xcskarel xcode select'
       c.description = 'Interactive xcode-select'

data/lib/xcskarel.rb

@@ -4,4 +4,6 @@ require 'xcskarel/version'
 require 'xcskarel/log'
 require 'xcskarel/filter'
 require 'xcskarel/control'
-require 'xcskarel/bot'
+require 'xcskarel/config'
+require 'xcskarel/xcsfile'
+require 'xcskarel/application'

data/lib/xcskarel/application.rb

@@ -0,0 +1,52 @@
+module XCSKarel
+  module Application
+    def self.choose_bot(server)
+      all_bots = server.get_bots
+      bot_names = all_bots.map { |json| "#{json['name']} (#{json['_id']})" }
+      puts "Which Bot should be used as a template?"
+      choice = choose(*bot_names)
+      bot = all_bots[bot_names.index(choice)]
+      XCSKarel.log.info "Chose Bot \"#{bot['name']}\""
+      return bot
+    end
+
+    def self.save_bot(config_folder, bot, api_version)
+      rand_name = XCSKarel::XCSFile.random_name
+      config_name = ask("Config name (hit Enter to accept generated name \"" + "#{rand_name}".yellow + "\"): ")
+      config_name = rand_name if config_name.length == 0
+      
+      # preprocess the config name first
+      require 'uri'
+      config_name = URI::escape(config_name.gsub(" ", "_"))
+
+      real_name = "botconfig_#{config_name}.json"
+      new_config_path = XCSKarel::XCSFile.new_config_name(config_folder, real_name)
+      new_config = XCSKarel::Config.new(bot, api_version, new_config_path)
+      new_config.save
+
+      XCSKarel.log.info "Saved Bot \"#{new_config.name}\" configuration to #{new_config_path}. Check this into your repository.".green
+      system "open \"#{new_config_path}\""
+    end
+
+    def self.list_configs(config_folder)
+      configs = XCSKarel::XCSFile.load_configs(config_folder)
+      if configs.count == 0
+        XCSKarel.log.info "Found no existing configs in #{config_folder}".yellow
+      else
+        out = "\n" + configs.map { |c| "\"#{c.name}\"".yellow + " [#{File.basename(c.path)}]".yellow + " - from Bot " + "#{c.original_bot_name}".yellow }.join("\n")
+        XCSKarel.log.info "Found #{configs.count} configs in \"#{config_folder}\":"
+        XCSKarel.log.info out
+      end
+    end
+
+    def self.show_config(config_folder)
+      configs = XCSKarel::XCSFile.load_configs(config_folder)
+      config_names = configs.map { |c| "Config " + "#{c.name}".yellow + " from Bot " + "#{c.original_bot_name}".yellow }
+      puts "Which config?"
+      choice = choose(*config_names)
+      config = configs[config_names.index(choice)]
+      XCSKarel.log.info "Editing config \"#{config.name}\""
+      system "open \"#{config.path}\""
+    end
+  end
+end

data/lib/xcskarel/config.rb

@@ -0,0 +1,86 @@
+module XCSKarel
+  class Config
+    attr_reader :json
+    attr_reader :path
+    attr_reader :api_version
+
+    def initialize(json, api_version, path)
+      @json = json
+      @path = path
+      @api_version = api_version || (config_json ? config_json['api_version'] : nil)
+    end
+
+    def name
+      (config_json['name'] || File.basename(@path).split('.').first).gsub("botconfig_", "")
+    end
+
+    def original_bot_name
+      @json['name'] || config_json['original_bot_name']
+    end
+
+    def config_json
+      @json['xcsconfig'] || {}
+    end
+
+    def key_paths_for_persistance
+      key_paths_for_xcode_server << "xcsconfig"
+    end
+
+    def key_paths_for_xcode_server
+      ["configuration"]
+    end
+
+    def format_version
+      1
+    end
+
+    def json_for_persistence
+      filtered = XCSKarel::Filter.filter_key_paths(@json, key_paths_for_persistance)
+
+      # also add xcsconfig metadata
+      unless filtered["xcsconfig"]
+        filtered["xcsconfig"] = {
+          format_version: format_version,
+          app_version: XCSKarel::VERSION,
+          original_bot_name: @json['name'],
+          name: name,
+          api_version: @api_version
+        }
+      end
+      return filtered
+    end
+
+    def json_for_xcode_server
+      XCSKarel::Filter.filter_key_paths(@json, key_paths_for_xcode_server)
+    end
+
+    def self.from_file(file_path)
+      abs_path = File.absolute_path(file_path)
+      raise "No file #{abs_path}" unless File.exist?(abs_path)
+      config = self.new(JSON.parse(File.read(abs_path)), nil, abs_path)
+      unless config.validate_loaded
+        XCSKarel.log.warn "Skipping invalid config #{abs_path}".yellow
+        return nil
+      end
+      return config
+    end
+
+    def validate_loaded
+      return false unless config_json
+      return true
+    end
+
+    def to_file(file_path)
+      abs_path = File.absolute_path(file_path)
+      raise "File #{abs_path} already exists. Choose a different name.".red if File.exist?(abs_path)
+      FileUtils.mkdir_p(File.dirname(abs_path))
+      File.open(abs_path, 'w') do |f|  
+        f.puts JSON.pretty_generate(json_for_persistence) + "\n"
+      end
+    end
+
+    def save
+      to_file(@path)
+    end
+  end
+end

data/lib/xcskarel/filter.rb

@@ -24,7 +24,9 @@ module XCSKarel
             key.split('.').first == keys.first
           end.first
           if match
-            new_hash[keys.first] = filter_key_paths(v, match.split('.').drop(1))
+            child_key_paths = match.split('.').drop(1)
+            # if there are no more key paths, we just take everything (whitelisted by default)
+            new_hash[keys.first] = child_key_paths.count == 0 ? v : filter_key_paths(v, child_key_paths)
           end
         end
         return new_hash

data/lib/xcskarel/server.rb

@@ -11,6 +11,7 @@ module XCSKarel
     attr_reader :user
     attr_reader :pass
     attr_reader :port
+    attr_reader :api_version
 
     def initialize(host, user=nil, pass=nil, allow_self_signed=true)
       @port = 20343
@@ -88,7 +89,8 @@ module XCSKarel
         raise "Failed to validate - #{e}.\nPlease make sure your Xcode Server is up and running at #{host}. Run `xcskarel server start` to start a new local Xcode Server instance.".red
       else
         raise "Failed to validate - Endpoint at \"#{url}\" responded with #{response.data[:status_line]}".red if response.status != 204
-        XCSKarel.log.debug "Validation of host #{@host} succeeded.".green
+        @api_version = response.headers['X-XCSAPIVersion'].to_s
+        XCSKarel.log.debug "Validation of host #{@host} (API version #{@api_version}) succeeded.".green
       end
     end
   end

data/lib/xcskarel/version.rb

@@ -1,3 +1,3 @@
 module XCSKarel
-  VERSION = '0.7.1'
+  VERSION = '0.8.0'
 end

data/lib/xcskarel/xcsfile.rb

@@ -0,0 +1,71 @@
+module XCSKarel
+  module XCSFile
+    def self.folder_name
+      "xcsconfig"
+    end
+
+    def self.file_name
+      "xcsfile.json"
+    end
+
+    def self.find_config_folder_in_current_folder
+      self.find_config_folder_in_folder(Dir.pwd)
+    end
+
+    def self.find_config_folder_in_folder(folder)
+      # look for the xcsconfig folder with an xcsfile inside
+      abs_folder = File.absolute_path(folder)
+      found_folder = Dir[File.join(abs_folder, "/", "*")].select do |f|
+        File.basename(f) == self.folder_name
+      end.first
+      return found_folder
+    end
+
+    def self.create_config_folder_in_current_folder
+      self.create_config_folder_in_folder(Dir.pwd)
+    end
+
+    def self.create_config_folder_in_folder(folder)
+      abs_folder = File.absolute_path(folder)
+      config_folder = File.join(abs_folder, self.folder_name)
+      FileUtils.mkdir_p(config_folder)
+      return config_folder
+    end
+
+    def self.get_config_folder
+      config_folder = XCSKarel::XCSFile.find_config_folder_in_current_folder
+      unless config_folder
+        should_create = agree("There is no xcsconfig folder found, should I create one for you? (y/n)".red)
+        if should_create
+          config_folder = XCSKarel::XCSFile.create_config_folder_in_current_folder unless config_folder
+          XCSKarel.log.debug "Folder #{config_folder} created".yellow
+        else
+          return nil
+        end
+      end
+      # we have a config folder
+      XCSKarel.log.debug "Config folder found: #{config_folder}".green
+      return config_folder
+    end
+
+    def self.load_configs(folder)
+      require 'json'
+      Dir[File.join(folder, "/", "botconfig_*.json")].map do |f|
+        XCSKarel::Config.from_file(f)
+      end.select do |c|
+        c != nil
+      end
+    end
+
+    def self.random_name
+      require 'securerandom'
+      "#{SecureRandom.hex(6)}"
+    end
+
+    def self.new_config_name(folder, name)
+      name = name.split('.').first + ".json"
+      File.join(folder, name)
+    end
+
+  end
+end

data/spec/filter_spec.rb

@@ -43,6 +43,25 @@ describe XCSKarel do
       expect(test(obj, ["oranges.old"])).to eq(exp)
     end
 
+    it "keeps full values when hashes and key is already whitelisted" do
+      obj = {
+        "apples" => "green",
+        "blackberries" => 12,
+        "oranges" => {
+          "new" => 2,
+          "old" => -2
+        }
+      }
+      exp = {
+        "apples" => "green",
+        "oranges" => {
+          "new" => 2,
+          "old" => -2
+        }
+      }
+      expect(test(obj, ["oranges", "apples"])).to eq(exp)
+    end
+
     it "handles basic key path with an array without popping the key path" do
       obj = [
         "apples",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xcskarel
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Honza Dvorsky
@@ -174,12 +174,14 @@ extra_rdoc_files: []
 files:
 - bin/xcskarel
 - lib/xcskarel.rb
-- lib/xcskarel/bot.rb
+- lib/xcskarel/application.rb
+- lib/xcskarel/config.rb
 - lib/xcskarel/control.rb
 - lib/xcskarel/filter.rb
 - lib/xcskarel/log.rb
 - lib/xcskarel/server.rb
 - lib/xcskarel/version.rb
+- lib/xcskarel/xcsfile.rb
 - spec/default_spec.rb
 - spec/filter_spec.rb
 homepage: http://github.com/czechboy0/xcskarel

data/lib/xcskarel/bot.rb

@@ -1,23 +0,0 @@
-module XCSKarel
-  class Bot
-    attr_reader :json
-    def initialize(json)
-      @json = json
-    end
-
-    def self.from_file(file_path)
-      abs_path = File.absolute_path(file_path)
-      raise "No file #{abs_path}" unless File.exist?(abs_path)
-      self.new(File.read(abs_path))
-    end
-
-    def to_file(file_path="./xcskarel/bot.json")
-      abs_path = File.absolute_path(file_path)
-      raise "File #{abs_path} already exists." if File.exist?(abs_path)
-      FileUtils.mkdir_p(File.dirname(abs_path))
-      File.open(abs_path, 'w') do |f|  
-        f.puts JSON.pretty_generate(@json) + "\n"
-      end  
-    end
-  end
-end