nabokov 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd71abc02d1c0469d5514b59900199790b2e9b8b
+  data.tar.gz: 355a0707bbe1ea7196595098da5450a948868be1
+SHA512:
+  metadata.gz: dc9ce5a4b6104c0b69074553d3a72ef7f49ae69ab83dd00a7051d44cd54ef69c0642abe87d5ad9d3e4c987fb1541be7a1cb181b1ad7712313ef411d2d7fbdd1e
+  data.tar.gz: 828af0acfaa649d4713954b55d711a3c4a7fc32553ed47e79b87f5249a0b1e8ed1ee0b901243631db111d4d1b0c8851d039c83aaef7fa2a86c00ea2d7f4fec89

data/.gitattributes

@@ -0,0 +1 @@
+CHANGELOG.md merge=union

data/.gitignore

@@ -0,0 +1,43 @@
+.DS_Store
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+/vendor/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+fastlane/report.xml
+.keys
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,113 @@
+AllCops:
+  Exclude:
+    - 'spec/fixtures/**/*'
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+# kind_of? is a good way to check a type
+Style/ClassCheck:
+  EnforcedStyle: kind_of?
+
+# It's better to be more explicit about the type
+Style/BracesAroundHashParameters:
+  Enabled: false
+
+# specs sometimes have useless assignments, which is fine
+Lint/UselessAssignment:
+  Exclude:
+    - '**/spec/**/*'
+
+# We could potentially enable the 2 below:
+Style/IndentHash:
+  Enabled: false
+
+Style/AlignHash:
+  Enabled: false
+
+# HoundCI doesn't like this rule
+Style/DotPosition:
+  Enabled: false
+
+# We allow !! as it's an easy way to convert ot boolean
+Style/DoubleNegation:
+  Enabled: false
+
+# Cop supports --auto-correct.
+Lint/UnusedBlockArgument:
+  Enabled: false
+
+# We want to allow class Fastlane::Class
+Style/ClassAndModuleChildren:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 60
+
+# The %w might be confusing for new users
+Style/WordArray:
+  MinSize: 19
+
+# raise and fail are both okay
+Style/SignalException:
+  Enabled: false
+
+# Better too much 'return' than one missing
+Style/RedundantReturn:
+  Enabled: false
+
+# Having if in the same line might not always be good
+Style/IfUnlessModifier:
+  Enabled: false
+
+# and and or is okay
+Style/AndOr:
+  Enabled: false
+
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 320
+
+Metrics/CyclomaticComplexity:
+  Max: 17
+
+# Configuration parameters: AllowURI, URISchemes.
+Metrics/LineLength:
+  Max: 370
+
+# Configuration parameters: CountKeywordArgs.
+Metrics/ParameterLists:
+  Max: 10
+
+Metrics/PerceivedComplexity:
+  Max: 18
+
+# Sometimes it's easier to read without guards
+Style/GuardClause:
+  Enabled: false
+
+# something = if something_else
+# that's confusing
+Style/ConditionalAssignment:
+  Enabled: false
+
+# Better to have too much self than missing a self
+Style/RedundantSelf:
+  Enabled: false
+
+Metrics/MethodLength:
+  Max: 60
+
+# We're not there yet
+Style/Documentation:
+  Enabled: false
+
+# Adds complexity
+Style/IfInsideElse:
+  Enabled: false
+
+# danger specific
+
+Style/BlockComments:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+bundler_args: "--without documentation --path bundle"
+
+before_install:
+  - gem install bundler

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## master
+
+## 0.1
+
+* The very beginning of the nabokov

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gem "rspec", "~> 3.4"
+gem "claide", "~> 1.0"
+gem "cork", "~> 0.1"
+gem "rake", "~> 10.0"
+gem "git", git: "https://github.com/Antondomashnev/ruby-git.git"
+
+gem "rubocop", "~> 0.42"

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Anton Domashnev
+
+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,16 @@
+# Nabokov
+Move mobile localization process up to the next level 🚀
+
+
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/Antondomashnev/nabokov/blob/master/LICENSE)
+
+## Current status
+This project is on the early development stage and is *not ready for production*. The `master` branch is empty and now the current status can be checked in `develop` branch. Also readme is not ready at all and we'll be updated as soon as the first functional becomes to the `master` branch.
+
+## Behind the scene
+This is my first ruby project except small experiments on the local machine before. So please bare it in mind and I would really appreciate any point about code style or even better way to implement something
+
+## License
+This project is open source under the MIT license, which means you have full access to the source code and can modify it to fit your own needs.
+
+

data/Rakefile

@@ -0,0 +1,22 @@
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+begin
+  require "rspec/core/rake_task"
+  RSpec::Core::RakeTask.new(:specs)
+rescue LoadError
+  puts "Please use `bundle exec` to get all the rake commands"
+end
+
+task default: :spec
+
+desc "Nabokov's tests"
+task :spec do
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+end
+
+desc "Run RuboCop on the lib/specs directory"
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = Dir.glob(["lib/**/*.rb", "spec/**/*.rb"]) - Dir.glob(["spec/fixtures/**/*"])
+end

data/bin/nabokov

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path("../../lib", __FILE__)
+
+require "nabokov"
+Nabokov::Runner.run ARGV

data/lib/nabokov/commands/runner.rb

@@ -0,0 +1,22 @@
+require "nabokov/version"
+require "nabokov/helpers/informator"
+require "claide"
+require "cork"
+
+module Nabokov
+  class Runner < CLAide::Command
+    self.abstract_command = true
+    self.summary = "Nabokov, the simple tool to keep your mobile app localization up to date."
+    self.version = Nabokov::VERSION
+    self.command = "nabokov"
+
+    def initialize(argv)
+      super
+      @cork = Cork::Board.new(silent: argv.option("silent", false), verbose: argv.option("verbose", false))
+    end
+
+    def ui
+      @ui ||= Informator.new(@cork)
+    end
+  end
+end

data/lib/nabokov/commands/setup.rb

@@ -0,0 +1,75 @@
+require "nabokov/commands/runner"
+require "fileutils"
+require "nabokov/core/nabokovfile"
+require "nabokov/core/file_manager"
+require "nabokov/git/git_repo"
+
+module Nabokov
+  # Command to setup the project repo to use nabokov
+  # It setups the pre commit hook to start Nabokov::LocalizationsRepoSyncer
+  class Setup < Runner
+    self.summary = "Setups the repository hook to sync app localizations."
+    self.command = "setup"
+    self.description = "Installs the pre-commit git hook with the logic to run 'nabokov sync localizations'"
+
+    attr_reader :pre_commit_file
+
+    def initialize(argv)
+      @pre_commit_file = argv.option("pre_commit_file")
+      @pre_commit_file ||= default_pre_commit_file
+      @git_path = argv.option("git_path")
+      @git_path ||= default_git_path
+      super
+    end
+
+    def run
+      ensure_pre_commit_file_exists
+      ensure_pre_commit_file_is_executable
+      ensure_hook_is_installed
+      ui.important "nabokov pre commit git hook is installed"
+      self
+    end
+
+    private
+
+    def ensure_pre_commit_file_exists
+      @pre_commit_file = File.realpath(@pre_commit_file) if File.symlink?(@pre_commit_file)
+      return if File.exist?(@pre_commit_file)
+
+      raise ".git folder is not found at '#{@git_path}'" unless Dir.exist?(@git_path)
+
+      FileUtils.mkdir_p("#{@git_path}/hooks")
+      @pre_commit_file = "#{@git_path}/hooks/pre-commit"
+      FileUtils.touch(@pre_commit_file)
+      FileUtils.chmod("u=xwr", @pre_commit_file)
+    end
+
+    def ensure_pre_commit_file_is_executable
+      raise "pre commit file at '#{@pre_commit_file}' is not executable by the effective user id of this process" unless File.executable?(@pre_commit_file)
+    end
+
+    def ensure_hook_is_installed
+      git_repo_path = ""
+      IO.popen("git rev-parse --show-toplevel", "r+") do |pipe|
+        git_repo_path = pipe.read
+      end
+      return if File.foreach(@pre_commit_file).grep(/git_repo_path/).any?
+
+      File.open(@pre_commit_file, "r+") do |f|
+        f.puts("#!/usr/bin/env bash")
+        f.puts("current_repo_path=\$(git rev-parse --show-toplevel)")
+        f.puts("nabokovfile_path=\"$current_repo_path/Nabokovfile.yaml\"")
+        f.puts("tracking_repo_path=\"#{git_repo_path.strip}\"")
+        f.puts("if [ \"$current_repo_path\" == \"$tracking_repo_path\" ] && gem list -i nabokov && [ -e \"$nabokovfile_path\" ]; then nabokov sync localizations --nabokovfile=$nabokovfile_path || exit 1; fi")
+      end
+    end
+
+    def default_git_path
+      ".git"
+    end
+
+    def default_pre_commit_file
+      "#{default_git_path}/hooks/pre-commit"
+    end
+  end
+end

data/lib/nabokov/commands/syncers/localizations_repo_syncer.rb

@@ -0,0 +1,101 @@
+require "nabokov/commands/syncers/syncer"
+require "nabokov/core/file_manager"
+require "nabokov/helpers/merger"
+
+module Nabokov
+  class LocalizationsRepoSyncer < Syncer
+    self.abstract_command = false
+    self.command = "localizations"
+    self.summary = "Synchronize remote localizations repo with the project localization strings."
+
+    def initialize(argv)
+      super
+      @synchronized_file_names = []
+    end
+
+    def validate!
+      super
+    end
+
+    def self.options
+      super
+    end
+
+    def run
+      ui.important("Nabokov starts localizations repo synchronization")
+      super
+      checkout_temporary_branch
+      has_changes = update_localization_files
+      checkout_master_branch
+      fetch_master_branch_changes
+      if has_changes && merge_master_branch_with_temporary(@rescue_commit_sha) == Nabokov::MergerResult::SUCCEEDED
+        push_changes_to_remote
+      end
+      delete_temporary_branch
+      notify_user_about_finish
+    end
+
+    private
+
+    def notify_user_about_finish
+      if @synchronized_file_names.count > 0
+        ui.say("#{@synchronized_file_names} have been updated on remote, your are all set for now 🎉")
+      else
+        ui.say("Nothing to synchronize, localizations in the remote repo and project repo are the same.")
+      end
+      ui.important("Nabokov has finished localizations remote repo synchronization")
+    end
+
+    def checkout_temporary_branch
+      ui.say("Checkout a temporary branch for new localization strings...") if self.verbose
+      self.git_repo.checkout_branch(temporary_branch)
+    end
+
+    def update_localization_files
+      has_changes = false
+      self.nabokovfile.project_localization_file_paths.each do |localization_file_name, localization_file_path|
+        ui.say("Copying strings file from '#{localization_file_path}' to the localization repo...") if self.verbose
+        new_file_path = FileManager.copy_and_rename(localization_file_path, self.git_repo.local_path, localization_file_name.to_s)
+        self.git_repo.add(new_file_path)
+        if self.git_repo.changes?
+          @synchronized_file_names << localization_file_name
+          self.git_repo.commit("Nabokov localization file '#{localization_file_name}' update...")
+          has_changes = true
+        else
+          ui.say("'#{localization_file_name}' file doesn't have any changes to commit...") if self.verbose
+        end
+      end
+      has_changes
+    end
+
+    def checkout_master_branch
+      ui.say("Checkout master branch...") if self.verbose
+      self.git_repo.checkout_branch(self.nabokovfile.localizations_repo_master_branch)
+      @rescue_commit_sha = self.git_repo.log(1)
+    end
+
+    def fetch_master_branch_changes
+      ui.say("Fetching remote master branch changes...") if self.verbose
+      self.git_repo.pull
+    end
+
+    def delete_temporary_branch
+      ui.say("Deleting temporary branch...") if self.verbose
+      self.git_repo.delete_branch(temporary_branch)
+    end
+
+    def push_changes_to_remote
+      ui.say("Pushing changes to remote...") if self.verbose
+      self.git_repo.push
+    end
+
+    def merge_master_branch_with_temporary(rescue_commit_sha = nil)
+      merger = Merger.new(ui, self.git_repo, rescue_commit_sha)
+      merger.merge(self.nabokovfile.localizations_repo_master_branch, temporary_branch)
+    end
+
+    def temporary_branch
+      "nabokov/temporary_branch"
+    end
+  end
+end

data/lib/nabokov/commands/syncers/project_syncer.rb

@@ -0,0 +1,106 @@
+require "nabokov/commands/syncers/syncer"
+require "nabokov/core/file_manager"
+require "nabokov/helpers/merger"
+require "nabokov/models/strings_file"
+
+module Nabokov
+  class ProjectSyncer < Syncer
+    self.abstract_command = false
+    self.command = "project"
+    self.summary = "Synchronize project localization strings with the remote localizations repo."
+
+    def initialize(argv)
+      super
+      @synchronized_file_names = []
+    end
+
+    def validate!
+      super
+    end
+
+    def self.options
+      super
+    end
+
+    def run
+      ui.important("Nabokov starts project repo synchronization")
+      super
+      fetch_localization_repo_master_branch_changes
+      init_project_git_repo
+      checkout_project_repo_temporary_branch
+      has_changes = update_localization_files_in_project_repo
+      checkout_project_repo_original_branch
+      if has_changes
+        merge_project_repo_original_branch_with_temporary
+      end
+      delete_temporary_branch
+      notify_user_about_finish
+    end
+
+    private
+
+    def notify_user_about_finish
+      if @synchronized_file_names.count > 0
+        ui.say("#{@synchronized_file_names} have been updated in project, your are all set for now 🎉")
+      else
+        ui.say("Nothing to synchronize, localizations in the remote repo and project repo are the same.")
+      end
+      ui.important("Nabokov has finished project repo synchronization")
+    end
+
+    def init_project_git_repo
+      @project_git_repo = GitRepo.new(@nabokovfile.project_local_path)
+      raise "Could not find the project repo at '#{Dir.exist?(@project_git_repo.local_path)}'" unless Dir.exist?(@project_git_repo.local_path)
+      ui.say("Found existed project repo at #{@project_git_repo.local_path}...") if self.verbose
+      @project_git_repo.init
+      @project_repo_original_branch = @project_git_repo.current_branch
+    end
+
+    def merge_project_repo_original_branch_with_temporary
+      merger = Merger.new(ui, @project_git_repo)
+      merger.merge(@project_repo_original_branch, temporary_branch)
+    end
+
+    def checkout_project_repo_temporary_branch
+      ui.say("Checkout porject repo temporary branch...") if self.verbose
+      @project_git_repo.checkout_branch(temporary_branch)
+    end
+
+    def checkout_project_repo_original_branch
+      ui.say("Checkout project repo #{@project_repo_original_branch} branch...") if self.verbose
+      @project_git_repo.checkout_branch(@project_repo_original_branch)
+    end
+
+    def update_localization_files_in_project_repo
+      has_changes = false
+      self.nabokovfile.project_localization_file_paths.each do |localization_file_name, localization_file_path|
+        localization_file_path_in_localization_repo = "#{self.git_repo.local_path}/#{localization_file_name}.#{Nabokov::StringsFile.extension}"
+        ui.say("Copying strings file from '#{localization_file_path_in_localization_repo}' to the project repo...") if self.verbose
+        new_file_path = FileManager.copy(localization_file_path_in_localization_repo, localization_file_path)
+        @project_git_repo.add(new_file_path)
+        if @project_git_repo.changes?
+          @synchronized_file_names << localization_file_name
+          @project_git_repo.commit("Nabokov has updated localization file '#{localization_file_name}'...")
+          has_changes = true
+        else
+          ui.say("'#{localization_file_name}' file doesn't have any changes to commit...") if self.verbose
+        end
+      end
+      has_changes
+    end
+
+    def fetch_localization_repo_master_branch_changes
+      ui.say("Fetching localization repo remote master branch changes...") if self.verbose
+      self.git_repo.pull
+    end
+
+    def delete_temporary_branch
+      ui.say("Deleting temporary branch...") if self.verbose
+      @project_git_repo.delete_branch(temporary_branch)
+    end
+
+    def temporary_branch
+      "nabokov/temporary_branch"
+    end
+  end
+end

data/lib/nabokov/commands/syncers/syncer.rb

@@ -0,0 +1,68 @@
+require "nabokov/commands/runner"
+require "nabokov/core/nabokovfile"
+require "nabokov/core/file_manager"
+require "nabokov/git/git_repo"
+
+module Nabokov
+  class Syncer < Runner
+    attr_reader :nabokovfile
+    attr_reader :git_repo
+
+    self.abstract_command = true
+    self.summary = "Synchronization between localizations and project."
+    self.command = "sync"
+
+    def initialize(argv)
+      nabokovfile = argv.option("nabokovfile")
+      unless nabokovfile
+        pwd_nabokovfile = Pathname.pwd + "Nabokovfile.yaml"
+        nabokovfile = pwd_nabokovfile if File.exist?(pwd_nabokovfile)
+      end
+      raise "--nabokovfile is a required parameter and could not be nil" if nabokovfile.nil?
+
+      @nabokovfile_path = nabokovfile if File.exist?(nabokovfile)
+      super
+    end
+
+    def validate!
+      super
+      if self.class == Syncer && !@nabokovfile_path
+        help! "Could not find a Nabokovfile."
+      end
+    end
+
+    def self.options
+      [
+        ["--nabokovfile=<path/to/nabokovfile>", "The location of your Nabokovfile"]
+      ].concat(super)
+    end
+
+    def run
+      initialize_nabokov_file
+      init_git_repo
+      self
+    end
+
+    def initialize_nabokov_file
+      @nabokovfile = Nabokovfile.new(@nabokovfile_path)
+      ui.say("Hooray, your Nabokovfile is valid...") if self.verbose
+    end
+
+    def init_git_repo
+      @git_repo = GitRepo.new(@nabokovfile.localizations_repo_local_path, @nabokovfile.localizations_repo_url)
+      if Dir.exist?(@git_repo.local_path)
+        ui.say("Found existed repo at #{@git_repo.local_path}...") if self.verbose
+        @git_repo.init
+      else
+        ui.say("Cloning the localization repo from #{@git_repo.remote_url} into #{@git_repo.local_path}...") if self.verbose
+        @git_repo.clone
+      end
+      checkout_master_branch
+    end
+
+    def checkout_master_branch
+      ui.say("Checkout master branch...") if self.verbose
+      @git_repo.checkout_branch(@nabokovfile.localizations_repo_master_branch)
+    end
+  end
+end

data/lib/nabokov/core/file_manager.rb

@@ -0,0 +1,36 @@
+require "fileutils"
+require "pathname"
+
+module Nabokov
+  # This class is the wrapper around the FileUtils
+  class FileManager
+    # Copies given file to the given destination
+    def self.copy(original_file_path, destination_file_path)
+      raise "Couldn't find file at '#{original_file_path}'" unless File.exist?(original_file_path)
+      FileUtils.cp(original_file_path, destination_file_path)
+      File.expand_path(destination_file_path)
+    end
+
+    # Copies given file to the given destination and renames to the given name
+    # Note: the extension of the file remains the same that's why new name can not contain '.'
+    def self.copy_and_rename(original_file_path, to_directory, new_name)
+      raise "Couldn't find file at '#{original_file_path}'" unless File.exist?(original_file_path)
+      raise "Couldn't find directory at '#{to_directory}'" unless Dir.exist?(to_directory)
+      raise "New name of the file could not be empty" if new_name.empty?
+      raise "New name of the file '#{new_name}' contains invalid character '.'" if new_name.include?(".")
+
+      original_file_pathname = Pathname.new(original_file_path)
+      original_file_extension = original_file_pathname.extname
+      new_file_pathname = Pathname.new(to_directory) + Pathname.new(new_name + original_file_extension)
+      new_file_path = new_file_pathname.to_s
+      FileUtils.cp(original_file_path, new_file_path)
+      File.expand_path(new_file_path)
+    end
+
+    # Removes the filve at the given path
+    def self.remove(path)
+      raise "Can not file neither file nor directory at '#{path}'" unless File.exist?(path) or Dir.exist?(path)
+      FileUtils.rm_rf(path)
+    end
+  end
+end