nabokov 0.1.0

data/lib/nabokov/core/nabokovfile.rb

@@ -0,0 +1,66 @@
+require "yaml"
+require "uri"
+require "nabokov/core/nabokovfile_keys"
+require "nabokov/core/nabokovfile_content_validator"
+
+module Nabokov
+  # Class represents the nabokovfile with the settings for nabokov
+  class Nabokovfile
+    # @return [String] The localizations repo url string
+    attr_accessor :localizations_repo_url
+    # @return [String] The localizations repo master branch
+    attr_accessor :localizations_repo_master_branch
+    # @return [String] The localizations repo local path
+    attr_accessor :localizations_repo_local_path
+    # @return [Hash] The Hash with key as localization name and value as repspected localization file path
+    attr_accessor :project_localization_file_paths
+    # @return [String] The project repo local path
+    attr_accessor :project_local_path
+
+    def initialize(path)
+      raise "Path is a required parameter" if path.nil?
+      raise "Couldn't find nabokov file at '#{path}'" unless File.exist?(path)
+      nabokovfile = File.read(path)
+      yaml_data = read_data_from_yaml_file(nabokovfile, path)
+      validate_content(yaml_data)
+      read_content(yaml_data)
+    end
+
+    def localizations_repo_local_path
+      return @localizations_repo_local_path unless @localizations_repo_local_path.nil?
+      @localizations_repo_local_path ||= ""
+    end
+
+    private
+
+    def read_data_from_yaml_file(yaml_file, path)
+      YAML.load(yaml_file)
+    rescue Psych::SyntaxError
+      raise "File at '#{path}' doesn't have a legit YAML syntax"
+    end
+
+    def validate_content(content_hash)
+      validator = NabokovfileContentValidator.new(content_hash)
+      validator.validate
+    end
+
+    def read_content(content_hash)
+      localizations_repo = content_hash[NabokovfileKeyes.localizations_repo]
+      self.localizations_repo_url = localizations_repo[NabokovfileKeyes.localizations_repo_url]
+      self.localizations_repo_master_branch = localizations_repo[NabokovfileKeyes.localizations_repo_master_branch].nil? ? "master" : localizations_repo[NabokovfileKeyes.localizations_repo_master_branch]
+      project_repo = content_hash[NabokovfileKeyes.project_repo]
+      self.project_localization_file_paths = project_repo[NabokovfileKeyes.project_localization_file_paths]
+      self.project_local_path = project_repo[NabokovfileKeyes.project_local_path]
+      self.localizations_repo_local_path = build_localization_local_path
+    end
+
+    def build_localization_local_path
+      repo_url_path = URI(self.localizations_repo_url).path.to_s
+      home_dir = Dir.home.to_s
+      repo_url_name_without_extension = File.basename(repo_url_path, File.extname(repo_url_path)).downcase
+      repo_url_organization = File.dirname(repo_url_path).downcase
+      nabokov_dir_name = "/.nabokov"
+      home_dir + nabokov_dir_name + repo_url_organization + "/" + repo_url_name_without_extension
+    end
+  end
+end

data/lib/nabokov/core/nabokovfile_content_validator.rb

@@ -0,0 +1,51 @@
+require "uri"
+require "nabokov/core/nabokovfile_keys"
+
+module Nabokov
+  # This class is responsible for nabokovfile content validation
+  # The validation rules are for localizations_repo and project_repo settings
+  class NabokovfileContentValidator
+    attr_accessor :nabokovfile_hash
+
+    def initialize(nabokovfile_hash)
+      self.nabokovfile_hash = nabokovfile_hash
+    end
+
+    # Performs validation
+    # First rule: localizations_repo should be the type of Hash
+    #             localizations_repo_url should be valid URL with secure https scheme
+    # Second rule: project_repo should be the type of Hash
+    #              project localizations_key should be the of Hash
+    #              project_localization_file_paths should point to existed files
+    #              project_local_path should point to valid folder
+    def validate
+      validate_localizations_repo
+      validate_project_repo
+    end
+
+    private
+
+    def validate_localizations_repo
+      localizations_repo = self.nabokovfile_hash[NabokovfileKeyes.localizations_repo]
+      raise "Localizations repo must be a type of Hash" unless localizations_repo.kind_of?(Hash)
+
+      url = localizations_repo[NabokovfileKeyes.localizations_repo_url]
+      raise "'#{url}' is not a valid URL" unless url =~ URI.regexp
+      raise "Please use 'https://...' instead of '#{url}' only supports encrypted requests" unless url.start_with?("https://")
+    end
+
+    def validate_project_repo
+      project_repo = self.nabokovfile_hash[NabokovfileKeyes.project_repo]
+      raise "Project repo must be a type of Hash" unless project_repo.kind_of?(Hash)
+
+      localizations_key = NabokovfileKeyes.project_localization_file_paths
+      localizations = project_repo[localizations_key]
+      raise "Localizations must be a type of Hash" unless localizations.kind_of?(Hash)
+      localizations.each_value { |path| raise "Couldn't find strings file at '#{path}'" unless File.exist?(path) }
+
+      project_local_path_key = NabokovfileKeyes.project_local_path
+      project_local_path = project_repo[project_local_path_key]
+      raise "Project repo local path must be presented" if project_local_path.nil?
+    end
+  end
+end

data/lib/nabokov/core/nabokovfile_keys.rb

@@ -0,0 +1,34 @@
+module Nabokov
+  # Class contains the named constants for nabokovfile keyes
+  class NabokovfileKeyes
+    # @return [String] The key to get the localizations repo settings
+    def self.localizations_repo
+      return "localizations_repo"
+    end
+
+    # @return [String] The key to get the localizations remote URL string
+    def self.localizations_repo_url
+      return "url"
+    end
+
+    # @return [String] The key to get the master branch of the localizations repo
+    def self.localizations_repo_master_branch
+      return "master_branch"
+    end
+
+    # @return [String] The key to get the project repo settings
+    def self.project_repo
+      return "project_repo"
+    end
+
+    # @return [String] The key to get the (localization_code => localization_file_path) hash
+    def self.project_localization_file_paths
+      return "localizations"
+    end
+
+    # @return [String] The key to get the project's local path
+    def self.project_local_path
+      return "local_path"
+    end
+  end
+end

data/lib/nabokov/git/git_repo.rb

@@ -0,0 +1,137 @@
+require "git"
+require "uri"
+require "securerandom"
+require "pathname"
+
+module Nabokov
+  # This class is basically the wrapper aroung the ruby-git gem
+  # Note: the ruby gem is taken not from gem spec repo, but from https://github.com/Antondomashnev/ruby-git
+  class GitRepo
+    # @return [String] Repo's remote URL, could be nil
+    attr_accessor :remote_url
+    # @return [String] Local path to the repo
+    attr_accessor :local_path
+    # @return [Git::Base] Underlying git repo
+    attr_reader :git_repo
+
+    def initialize(local_path, remote_url = nil, git_repo = nil)
+      raise "local_path is a required parameter" if local_path.nil?
+      expanded_local_path = File.expand_path(local_path)
+      @local_pathname = Pathname.new(expanded_local_path)
+      @git_repo = git_repo
+      self.remote_url = remote_url
+      self.local_path = expanded_local_path
+    end
+
+    def clone
+      raise "Git repo has been already cloned at '#{self.local_path}', please use 'init' instead" if repo_exist_at_local_path
+      @git_repo ||= Git.clone(self.remote_url, @local_pathname.basename.to_s, path: @local_pathname.parent.to_s)
+    end
+
+    def init
+      raise "Git repo has not been cloned yet from '#{self.remote_url}', please use 'clone' instead" unless repo_exist_at_local_path
+      @git_repo ||= Git.init(self.local_path)
+    end
+
+    def add(file_path)
+      raise "Could not find any file to add at path '#{file_path}'" unless File.exist?(file_path)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before adding new files to the index" if @git_repo.nil?
+      @git_repo.add(file_path)
+    end
+
+    def commit(message = nil)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before commiting new files" if @git_repo.nil?
+      message ||= "Automatic commit by nabokov"
+      @git_repo.commit(message)
+    end
+
+    def push
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before pushing any changes to remote" if @git_repo.nil?
+      @git_repo.push
+    end
+
+    def pull
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before pushing any changes to remote" if @git_repo.nil?
+      @git_repo.pull
+    end
+
+    def checkout_branch(name)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before checkouting any branch" if @git_repo.nil?
+      raise "branch name could not be nil or zero length" if name.nil? || name.length.zero?
+      if @git_repo.is_branch?(name)
+        @git_repo.checkout(name)
+      else
+        @git_repo.checkout(name, { new_branch: true })
+      end
+    end
+
+    def delete_branch(name)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before deleting any branch" if @git_repo.nil?
+      raise "branch name could not be nil or zero length" if name.nil? || name.length.zero?
+      @git_repo.branch(name).delete
+    end
+
+    def merge_branches(original_branch, branch_to_be_merged)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before merging any branches" if @git_repo.nil?
+      raise "original branch name could not be nil or zero length" if original_branch.nil? || original_branch.length.zero?
+      raise "branch to be merged in name could not be nil or zero length" if branch_to_be_merged.nil? || branch_to_be_merged.length.zero?
+      @git_repo.branch(original_branch).merge(@git_repo.branch(branch_to_be_merged))
+    end
+
+    def changes?
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before checking if the git repo has changes" if @git_repo.nil?
+      return true if @git_repo.status.deleted.count > 0
+      return true if @git_repo.status.added.count > 0
+      return true if @git_repo.status.changed.count > 0
+      false
+    end
+
+    def unfinished_merge?
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before checking if the git repo has unfinished merge" if @git_repo.nil?
+      return @git_repo.has_unmerged_files?
+    end
+
+    def current_branch
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before getting the current branch" if @git_repo.nil?
+      return @git_repo.current_branch
+    end
+
+    def abort_merge
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before aborting merge" if @git_repo.nil?
+      raise "nothing to abort - git repo doesn't have unfinished merge" unless self.unfinished_merge?
+      @git_repo.abort_merge
+    end
+
+    def unmerged_files
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before asking for unmerged files" if @git_repo.nil?
+      return [] unless @git_repo.has_unmerged_files?
+      conflicted_files = []
+      @git_repo.each_conflict do |file, your_version, their_version|
+        conflicted_files << file
+      end
+      conflicted_files
+    end
+
+    def reset_to_commit(commit_sha, options = {})
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before resetting" if @git_repo.nil?
+      raise "'commit' is a required parameter and could not be nil" if commit_sha.nil?
+      if options[:hard]
+        @git_repo.reset_hard(commit_sha)
+      else
+        @git_repo.reset(commit_sha)
+      end
+    end
+
+    def log(number_of_commits)
+      raise "'git' is not initialized yet, please call either 'clone' or 'init' before getting the log" if @git_repo.nil?
+      commits = @git_repo.log(number_of_commits)
+      commits.map(&:sha)
+    end
+
+    private
+
+    def repo_exist_at_local_path
+      Dir.exist?(self.local_path)
+    end
+  end
+end

data/lib/nabokov/helpers/informator.rb

@@ -0,0 +1,83 @@
+require "cork"
+
+module Nabokov
+  # This class is heavily based on the Interviewer class from the Danger gem
+  # The original link is https://github.com/danger/danger/blob/master/lib/danger/commands/init_helpers/interviewer.rb
+  class Informator
+    attr_accessor :no_waiting, :ui
+
+    def initialize(cork_board)
+      @ui = cork_board
+    end
+
+    def show_prompt
+      ui.print("> ".bold.green)
+    end
+
+    def say(message)
+      ui.puts(message)
+    end
+
+    def inform(message)
+      ui.puts(message.green)
+    end
+
+    def important(message)
+      i = message.length + 8
+      inform("-" * i)
+      inform("--- " + message + " ---")
+      inform("-" * i)
+    end
+
+    def warn(message)
+      ui.puts(message.yellow)
+    end
+
+    def error(message)
+      ui.puts(message.red)
+    end
+
+    def wait_for_return
+      STDOUT.flush
+      STDIN.gets unless @no_waiting
+      ui.puts
+    end
+
+    def ask_with_answers(question, possible_answers)
+      ui.print("\n#{question}? [")
+
+      print_info = proc do
+        possible_answers.each_with_index do |answer, i|
+          the_answer = i.zero? ? answer.underline : answer
+          ui.print " " + the_answer
+          ui.print(" /") if i != possible_answers.length - 1
+        end
+        ui.print " ]\n"
+      end
+      print_info.call
+
+      answer = ""
+
+      loop do
+        show_prompt
+        answer = @no_waiting ? possible_answers[0].downcase : STDIN.gets.downcase.chomp
+
+        answer = "yes" if answer == "y"
+        answer = "no" if answer == "n"
+
+        # default to first answer
+        if answer == ""
+          answer = possible_answers[0].downcase
+          ui.puts "Using: " + answer.yellow
+        end
+
+        break if possible_answers.map(&:downcase).include? answer
+
+        ui.print "\nPossible answers are ["
+        print_info.call
+      end
+
+      answer
+    end
+  end
+end

data/lib/nabokov/helpers/merger.rb

@@ -0,0 +1,86 @@
+require "nabokov/git/git_repo"
+require "nabokov/helpers/informator"
+
+module Nabokov
+  # Result of the merge action perfomed by Nabokov::Merger
+  class MergerResult
+    SUCCEEDED = "succeeded".freeze
+    ABORTED = "aborted".freeze
+  end
+
+  # Class is responsible for merging two branches
+  class Merger
+    def initialize(informator, git_repo, rescue_commit_sha = nil)
+      raise "'informator' is a required parameter" if informator.nil?
+      raise "'git_repo' is a required parameter" if git_repo.nil?
+      @rescue_commit_sha = rescue_commit_sha
+      @git_repo = git_repo
+      @informator = informator
+    end
+
+    # Merges one branch with another branch
+    # It handles the situation when there are merge conflicts and provides
+    #    the interface to the user to resolve the conflicts
+    def merge(head, branch)
+      @git_repo.merge_branches(head, branch)
+      MergerResult::SUCCEEDED
+    rescue Git::GitExecuteError
+      rescue_merge
+    end
+
+    private
+
+    def rescue_merge
+      ui.error("Merge failed with conflicts. Nabokov needs your help to continue")
+      proceed_option = ui.ask_with_answers("Would you like to resolve the conflicts manually or abort the synchronization?\n", ["resolve", "abort"])
+      if proceed_option == "abort"
+        abort_merge
+      elsif proceed_option == "resolve"
+        resolve_merge
+      end
+    end
+
+    def abort_merge
+      @git_repo.abort_merge
+      @git_repo.reset_to_commit(@rescue_commit_sha, { hard: true }) unless @rescue_commit_sha.nil?
+      MergerResult::ABORTED
+    end
+
+    def resolve_merge
+      ui.say("Great! Please resolve conflict in the following files:")
+      unmerged_files = @git_repo.unmerged_files
+      unmerged_files.each do |file|
+        file_path = @git_repo.local_path + "/" + file
+        ui.say("* #{file_path}")
+      end
+      ui.say("Please press return when you're ready to move on...")
+      ui.wait_for_return
+      commit_after_merge_resolving(unmerged_files)
+      MergerResult::SUCCEEDED
+    end
+
+    def commit_after_merge_resolving(merged_files)
+      commit_merge = proc do
+        merged_files.each do |file|
+          file_path = @git_repo.local_path + "/" + file
+          ui.say("Adding #{file_path} to git index...")
+          @git_repo.add(file_path)
+        end
+        ui.say("Commiting merge conflicts resolving...")
+        @git_repo.commit("Nabokov merge conflicts manually have been resolved...")
+      end
+
+      if @git_repo.changes?
+        commit_merge.call
+      else
+        ui.warn("Seems like you haven't resolved the merge, if you want to continue anyway please press return...")
+        ui.wait_for_return
+        commit_merge.call if @git_repo.changes?
+      end
+    end
+
+    def ui
+      @informator
+    end
+  end
+end

data/lib/nabokov/models/strings_file.rb

@@ -0,0 +1,7 @@
+module Nabokov
+  class StringsFile
+    def self.extension
+      return "strings"
+    end
+  end
+end

data/lib/nabokov/version.rb

@@ -0,0 +1,8 @@
+module Nabokov
+  VERSION = "0.1.0".freeze
+  DESCRIPTION = "One of the way to work on the localization - store it in the separate github repo
+                 and asks localization team to update files in that repo.
+                 This solution brings as well advantages but as well a disadvantages, to minimize the disadvantages
+                 nabokov was invented. It helps developer to automatically keep remote localzation up to date and
+                 also remain the project localization up to date as well.".freeze
+end

data/lib/nabokov.rb

@@ -0,0 +1,14 @@
+require "nabokov/version"
+require "nabokov/core/nabokovfile"
+require "nabokov/commands/runner"
+require "nabokov/commands/syncers/syncer"
+require "nabokov/commands/syncers/localizations_repo_syncer"
+require "nabokov/commands/syncers/project_syncer"
+require "nabokov/commands/setup"
+
+require "claide"
+require "pathname"
+require "cork"
+
+module Nabokov
+end

data/nabokov.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "nabokov/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "nabokov"
+  spec.version       = Nabokov::VERSION
+  spec.authors       = ["Anton Domashnev"]
+  spec.email         = ["antondomashnev@gmail.com"]
+  spec.description   = Nabokov::DESCRIPTION
+  spec.summary       = "Move mobile localization boringness away from you 🏃"
+  spec.homepage      = "https://github.com/Antondomashnev/nabokov"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_runtime_dependency "rspec", "~> 3.4"
+  spec.add_runtime_dependency "git", "~> 1.0"
+  spec.add_runtime_dependency "claide", "~> 1.0"
+  spec.add_runtime_dependency "cork", "~> 0.1"
+
+  spec.add_development_dependency "rubocop", "~> 0.42"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+end

data/spec/fixtures/README.md

@@ -0,0 +1 @@
+Nabokov template repo for specs

data/spec/fixtures/de.strings

@@ -0,0 +1 @@
+"hello" = "hallo";

data/spec/fixtures/en.strings

@@ -0,0 +1 @@
+"hello" = "hello";

data/spec/fixtures/nabokovfile_example.yaml

@@ -0,0 +1,9 @@
+localizations_repo:
+  url: 'https://github.com/Antondomashnev/nabokov_example.git'
+  master_branch: 'shmaster'
+
+project_repo:
+  localizations:
+    :en: 'spec/fixtures/en.strings'
+    :de: 'spec/fixtures/de.strings'
+  local_path: 'spec/fixtures/local_project'

data/spec/fixtures/nabokovfile_example_invalid.yaml

@@ -0,0 +1,2 @@
+localizations_repo: 'bla_bla_bla'
+localizations fake

data/spec/fixtures/nabokovfile_example_without_master_branch.yaml

@@ -0,0 +1,8 @@
+localizations_repo:
+  url: 'https://github.com/Antondomashnev/nabokov_example.git'
+
+project_repo:
+  localizations:
+    :en: 'spec/fixtures/en.strings'
+    :de: 'spec/fixtures/de.strings'
+  local_path: 'spec/fixtures/local_project'

data/spec/fixtures/test_localizations_repo_syncer/localizations_repo_fixtures/README.md

@@ -0,0 +1 @@
+Nabokov template repo for specs

data/spec/fixtures/test_localizations_repo_syncer/nabokovfile.yaml

@@ -0,0 +1,8 @@
+localizations_repo:
+  url: 'https://github.com/Antondomashnev/nabokov_example.git'
+
+project_repo:
+  localizations:
+    :en: 'spec/fixtures/en.strings'
+    :de: 'spec/fixtures/de.strings'
+  local_path: 'spec/fixtures/local_project'

data/spec/fixtures/test_project_syncer/localizations_repo_fixtures/de.strings

@@ -0,0 +1,2 @@
+"hello" = "Hallo";
+"bye" = "Tschuss";

data/spec/fixtures/test_project_syncer/localizations_repo_fixtures/en.strings

@@ -0,0 +1,2 @@
+"hello" = "Hello";
+"bye" = "Bye";

data/spec/fixtures/test_project_syncer/project_repo_fixtures/de.strings

@@ -0,0 +1,2 @@
+"hello" = "Hello";
+"bye" = "Bye";

data/spec/fixtures/test_project_syncer/project_repo_fixtures/en.strings

@@ -0,0 +1,2 @@
+"hello" = "Hello";
+"bye" = "Bye";

data/spec/fixtures/test_project_syncer/project_repo_fixtures/nabokovfile.yaml

@@ -0,0 +1,9 @@
+localizations_repo:
+  url: 'https://github.com/Antondomashnev/nabokov_example.git'
+  master_branch: 'master'
+
+project_repo:
+  localizations:
+    :en: 'spec/fixtures/test_project_syncer/project_repo/en.strings'
+    :de: 'spec/fixtures/test_project_syncer/project_repo/de.strings'
+  local_path: 'spec/fixtures/test_project_syncer/project_repo'