Provided service-based architecture, wrote readme

Author: ailecksandr

README.md

@@ -0,0 +1,50 @@
+# Git User Services ![GitHubCat](https://github.com/favicon.ico)
+
+Small application with own service-based architecture.
+
+### Main purpose:
+Changing git user in .gitconfig by round-robin.
+
+### Usage:
+1. Separate user configuration lines must be commented in _<.gitconfig>_:
+```bash
+    [user]
+        # email = [email protected]
+        # name = Sample User 1
+        email = [email protected]
+        name = Sample User 2
+        # email = [email protected]
+        # name = Sample User 3
+```
+
+2. Execute by
+```bash
+    ruby actions/change.rb
+```
+3. After successful execution you will receive information about current user:
+```bash
+    ## Email was replaced to [email protected] ##
+    ## Name was replaced to Sample User 3 ##
+    ## <.gitconfig> was changed successfully! ##
+```
+Also you can execute code in silent mode - just pass `silent: true` to `Change::Process` service.
+4. Current user will be changed to next in order:
+```bash
+    [user]
+    	# email = [email protected]
+    	# name = Sample User 1
+    	# email = [email protected]
+    	# name = Sample User 2
+    	email = [email protected]
+    	name = Sample User 3
+```
+### Script-usage:
+Simplified version of application is placed in `script` folder.
+1. Move to `script` folder:
+```bash
+    cd script
+```
+2. Run shell script using
+```bash
+    ./guser.sh
+```

actions/change.rb

@@ -1,5 +1,3 @@
-require '../application'
+require_relative '../application'
 
-params = {}
-
-Change::Perform.(params)
+Change::Process.()

application.rb

@@ -1,4 +1,5 @@
-require_relative 'lib/loader'
+ROOT_PATH = File.dirname(__FILE__)
 
-Lib::Loader.()
-Change::Process.()
+require File.join(ROOT_PATH, 'lib/loader')
+
+Lib::Loader.(ROOT_PATH)

lib/README.md

@@ -0,0 +1,44 @@
+# Application skeleton
+
+### Loader
+Service that load all skeleton services and classes.
+
+### OperatingSystem
+Class for detecting current OS.
+
+### Service
+Base service that provides functional-way execution and params validations.
+
+### Concerns::StateMachine
+Module that provides common state machine and state machine with multiple field states.
+
+### Error
+Base class for errors implementation. Errors requires:
+- `column` - service attribute name;
+- `error_type` - type of error;
+- `options` - related to `error_type`.
+
+### Error::Collection
+Collection for errors that provides some additional methods.
+
+### Error::Type
+Class that contains constants of types of errors. Additional options for errors with different error types:
+
+|Type        |Options                   |
+|------------|--------------------------|
+|BLANK       |---                       |
+|INVALID_TYPE|`class_name` - valid class|
+|NOT_INCLUDED|`in` - valid collection   |
+
+
+
+
+
+
+
+
+
+
+
+
+

lib/concerns/state_machine.rb

@@ -2,7 +2,7 @@ module Lib
   module Concerns
     module StateMachine
       def state_machine(column, states)
-        assign_reader!(column)
+        assign_reader!(column, states[0])
 
         states.each do |key|
           define_method("#{key}!") { instance_variable_set(column, key) }
@@ -11,7 +11,8 @@ def state_machine(column, states)
       end
 
       def multi_state_machine(column, states)
-        assign_reader!(column)
+        assign_reader!(column, Hash.new)
+        assign_initializing!(column, states[0])
 
         states.each do |key|
           define_method "#{key}!" do |field|
@@ -22,6 +23,10 @@ def multi_state_machine(column, states)
             instance_variable_get("@#{column}")[field] == key
           end
 
+          define_method "not_#{key}?" do |field|
+            instance_variable_get("@#{column}")[field] != key
+          end
+
           define_method "has_#{key}?" do
             instance_variable_get("@#{column}").values.any? { |state| state == key }
           end
@@ -30,9 +35,17 @@ def multi_state_machine(column, states)
 
       private
 
-      def assign_reader!(column)
-        define_method(column) do
-          eval("@#{column} ||= #{Hash.new}")
+      def assign_reader!(column, state)
+        define_method("#{column}") do
+          eval("@#{column} ||= #{state}")
+        end
+      end
+
+      def assign_initializing!(column, state)
+        define_method "init_#{column}!" do |fields|
+          init_states = Hash[fields.map { |field| [field, state] }]
+
+          instance_variable_set("@#{column}", init_states)
         end
       end
     end

lib/loader.rb

@@ -1,12 +1,16 @@
 module Lib
   class Loader
     class << self
-      def call
+      def call(root_path)
+        @root_path = root_path
+
         require!
       end
 
       private
 
+      attr_reader :root_path
+
       def require!
         app_folders.each { |folder| require_folder(folder) }
       end
@@ -20,7 +24,7 @@ def app_folders
       end
 
       def path(folder)
-        File.join('.', "#{folder}/**/*.rb")
+        File.join(root_path, "#{folder}/**/*.rb")
       end
     end
   end

lib/operating_system.rb

@@ -0,0 +1,26 @@
+module Lib
+  class OperatingSystem
+    class << self
+      def windows?
+        !(RUBY_PLATFORM =~ WINDOWS_REGEXP).nil?
+      end
+
+      def mac?
+        !(RUBY_PLATFORM =~ MAC_REGEXP).nil?
+      end
+
+      def unix?
+        !windows?
+      end
+
+      def linux?
+        unix? && !mac?
+      end
+
+      private
+
+      WINDOWS_REGEXP = /cygwin|mswin|mingw|bccwin|wince|emx/
+      MAC_REGEXP     = /darwin/
+    end
+  end
+end

lib/service.rb

@@ -14,14 +14,14 @@ def run
       @errors = Error::Collection.new
 
       validate!
-      return invalid_params! unless valid?
+      return invalid_params! unless service_valid?
 
       call
     end
 
     def validate!; end
 
-    def valid?
+    def service_valid?
       errors.empty?
     end
 

script/guser.rb

@@ -0,0 +1,110 @@
+class ChangeGitUser
+	def self.call(args = {})
+		new(args).call
+	end
+
+	def initialize(params = {})
+		@silent    = params[:silent]
+
+		prepare!
+	end
+
+	def call
+		read!
+		return unless valid?
+
+		change!
+		write!
+	end
+
+	private
+
+	STATES    = [:initialized, :commented, :replaced]
+	FIELDS    = [:name, :email]
+	FILE_NAME = "#{ENV['HOME']}/.gitconfig"
+
+	attr_reader :config, :silent, :left_border, :right_border, :field_states
+
+	STATES.each do |key|
+		define_method "#{key}!" do |field|
+			@field_states[field] = key
+		end
+
+		define_method "#{key}?" do |field|
+			field_states[field] == key
+		end
+
+		define_method "has_#{key}?" do
+			field_states.values.any? { |state| state == key }
+		end
+	end
+
+	def prepare!
+		@field_states = Hash.new
+		FIELDS.each { |field| initialized!(field) }
+	end
+
+	def read!
+		@config = File.read(FILE_NAME).split("\n")
+	end
+
+	def valid?
+		@left_border = config.find_index{ |row| row.include? '[user]' }
+		return echo('## There is not user configurations section! ##') if left_border.nil?
+
+		@left_border += 1
+		set_right_border!
+
+		return echo('## User configurations section is empty! ##') if left_border >= right_border
+		true
+	end
+
+	def change!
+		begin
+			(left_border..right_border).each { |index| change_row!(index) }
+		end while has_commented?
+	end
+
+	def write!
+		File.open(FILE_NAME, "w") { |file| file.puts(config) }
+		echo('## Config was changed successfully! ##')
+	rescue
+		echo('## Read-only access! ##')
+	end
+
+	def set_right_border!
+		local_right_border = config[left_border..-1].find_index{ |row| row.match(/\A[\[].*[\]]/) }
+		@right_border      = local_right_border.nil? ? config.size - 1 : local_right_border + left_border
+	end
+
+	def change_row!(index)
+		FIELDS.each { |field| replace(index, field) }
+	end
+
+	def replace(index, field)
+		patterns = patterns(field)
+
+		case
+		when config[index].include?(patterns[:commented]) && commented?(field)
+			config[index].gsub!(patterns[:commented], patterns[:uncommented])
+			echo("## \"#{config[index].split('=').last.lstrip}\" is current user ##") if field == :name
+			replaced!(field)
+		when config[index].include?(patterns[:uncommented]) && initialized?(field)
+			config[index].gsub!(patterns[:uncommented], patterns[:commented])
+			commented!(field)
+		end
+	end
+
+	def patterns(field)
+		{ 
+			commented: "\t# #{field}", 
+			uncommented: "\t#{field}" 
+		}
+	end
+
+	def echo(text)
+		puts(text) unless silent	
+	end
+end
+
+ChangeGitUser.()

script/guser.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+ruby guser.rb

services/change/file_service.rb

@@ -32,7 +32,7 @@ def prepare!
     end
 
     def read!
-      puts File.read(file_path)
+      File.read(file_path)
     end
 
     def write!
@@ -51,4 +51,3 @@ def file_name
     end
   end
 end
-