dtk-common 0.7.6 → 0.8.0

data/README.md

@@ -1,15 +1,14 @@
 dtk-common
 ==========
 
-DTK Common
-
-
-GITOLITE
-=========
+What it is?
+----------------------
+This is helper library used across DTK components (dtk-server, dtk-repo-manager). Since it is included as dependency on DTK components, there is no need for installing/configuring it separately. We use [Gitolite](https://github.com/sitaramc/gitolite) for fine-grained access control to our component and service modules. One of the functionalities that dtk-common exposes is interaction with Gitolite via Gitolite Manager. Below is an example why and how Gitolite manager is used.
 
+Gitolite manager usage
+----------------------
 Manager takes responsibility of handling all gitolite methods (or at least most of them). Reason is simple, gitolite commit / push are expensive operations and we want to mitigate that fact by using manager, and making sure that all our changes are under one commit / push.
 
-
 Example: Adding user/user group/all to repo configuration
 
     manager = Gitolite::Manager.new('/home/git/gitolite-admin')
@@ -32,6 +31,18 @@ Example: Adding user/user group/all to repo configuration
     manager.push()
 
 
-License
-----------------------
-DTK Common is released under the GPLv3 license. Please see LICENSE for more details.
+## License
+
+dtk-common is copyright (C) 2010-2016 dtk contributors
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License in the [LICENSE](LICENSE) file, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,15 @@
+desc "Add copyright headers"
+task :headers do
+  require 'rubygems'
+  require 'copyright_header'
+
+  args = {
+    :license_file => '.license_header',
+    :add_path => 'lib/',
+    :output_dir => '.',
+    :guess_extension => true,
+  }
+
+  command_line = CopyrightHeader::CommandLine.new( args )
+  command_line.execute
+end

data/dtk-common.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = DtkCommon::VERSION
 
   gem.add_dependency 'rugged','~> 0.17.0.b7'
-  gem.add_dependency 'dtk-common-core','0.7.3'
+  gem.add_dependency 'dtk-common-core','0.8.0'
   gem.add_dependency 'colorize','~> 0.5.8'
   # gem.add_dependency 'sequel','~> 3.40.0'
   # gem.add_dependency 'rdoc','~> 3.12'

data/lib/common_patch.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 #TODO: just putting in hooks for errors and logs
 #need to figure out how to hook calling library's errors
 
@@ -13,4 +30,4 @@ module DtkCommon
   module Aux
     extend ::DTK::Common::AuxMixin
   end
-end
+end

data/lib/dsl/directory_parser/git.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require File.expand_path('../../git_repo.rb',File.dirname(__FILE__))
 module DtkCommon; module DSL
   class DirectoryParser
@@ -36,4 +53,4 @@ module DtkCommon; module DSL
       end
     end
   end
-end; end
+end; end

data/lib/dsl/directory_parser/linux.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon; module DSL
   class DirectoryParser
     class Linux < self
@@ -18,4 +35,4 @@ module DtkCommon; module DSL
       end
     end
   end
-end; end
+end; end

data/lib/dsl/directory_parser.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
   module DSL
     class DirectoryParser
@@ -132,4 +149,4 @@ module DtkCommon
       }
     end
   end
-end
+end

data/lib/dsl/file_parser/file_types/assembly/v2/assembly.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon; module DSL; class FileParser
   class Assembly < self
     class OutputArray < FileParser::OutputArray
@@ -49,5 +66,4 @@ module DtkCommon; module DSL; class FileParser
 
     end
   end
-end; end; end
-
+end; end; end

data/lib/dsl/file_parser/file_types/component_module_refs/v1/component_module_refs.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon; module DSL; class FileParser
   class ComponentModuleRefs < self
     class V1 < self
@@ -60,5 +77,4 @@ module DtkCommon; module DSL; class FileParser
       end
     end
   end
-end; end; end
-
+end; end; end

data/lib/dsl/file_parser.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require 'singleton'
 require 'json'
 require 'yaml'
@@ -224,4 +241,4 @@ module DtkCommon
       end
     end
   end
-end
+end

data/lib/dsl.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 
 module DtkCommon
   module DSL    
@@ -16,8 +33,4 @@ module DtkCommon
     require File.expand_path('dsl/directory_parser', File.dirname(__FILE__))
     require File.expand_path('dsl/file_parser', File.dirname(__FILE__))
   end
-end
-
-
-
-
+end

data/lib/dtk-common/version.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
-  VERSION="0.7.6"
+  VERSION="0.8.0"
 end

data/lib/dtk_common.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DTK
   module Common
 
@@ -33,4 +50,4 @@ module DTK
       require file unless file.include?('dtk-common.rb') || file.include?('file_access/') || file.include?('require_first.rb') || file.include?('postgres.rb') || file.include?('rugged/')
     end
   end
-end
+end

data/lib/dynamic_loader.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require File.expand_path('common_patch',File.dirname(__FILE__))
 require 'thread'
 
@@ -24,5 +41,4 @@ module DtkCommon
       Aux.snake_to_camel_case(x.to_s)
     end
   end
-end
-
+end

data/lib/git_repo/adapters/rugged/blob.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
   class GitRepo::Adapter::Rugged
     class Blob < Obj
@@ -11,4 +28,4 @@ module DtkCommon
       end
     end
   end
-end
+end

data/lib/git_repo/adapters/rugged/commit.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
   class GitRepo::Adapter::Rugged
     class Commit < Obj
@@ -11,4 +28,4 @@ module DtkCommon
       end
     end
   end
-end
+end

data/lib/git_repo/adapters/rugged/common.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
   class GitRepo::Adapter::Rugged
     class Branch
@@ -30,5 +47,4 @@ module DtkCommon
       end
     end
   end
-end
-
+end

data/lib/git_repo/adapters/rugged/tree.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module DtkCommon
   class GitRepo::Adapter::Rugged
     class Tree < Obj
@@ -37,4 +54,4 @@ module DtkCommon
 
     end
   end
-end
+end

data/lib/git_repo/adapters/rugged.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require File.expand_path('../../git_repo.rb',File.dirname(__FILE__))
 require 'rugged'
 module DtkCommon
@@ -42,4 +59,4 @@ module DtkCommon
       end
     end
   end; end
-end
+end

data/lib/git_repo.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require File.expand_path('common_patch',File.dirname(__FILE__))
 require File.expand_path('dynamic_loader',File.dirname(__FILE__))
 #TODO: this will eventually replace the grit_adapter classes
@@ -86,8 +103,4 @@ module DtkCommon
 #      :rugged => proc{!::Gem::Specification::find_all_by_name('rugged',::Gem::Requirement.new(NailedRuggedVersion)).empty?}
     }
   end
-end
-
-
-
-
+end

data/lib/gitolite/configuration.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module Gitolite
   class Configuration
 
@@ -32,4 +49,4 @@ module Gitolite
       "#{@home_dir}/repositories/#{repo_name}.git"
     end 
   end
-end
+end

data/lib/gitolite/errors.rb

@@ -1,5 +1,22 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module Gitolite
   class Duplicate   < StandardError; end
   class NotFound    < StandardError; end
   class ParseError  < StandardError; end
-end
+end

data/lib/gitolite/grit/adapter.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 require 'grit'
 
 module Gitolite
@@ -104,4 +121,4 @@ module Gitolite
 
     end
   end
-end
+end

data/lib/gitolite/grit/file_access.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 module Gitolite
   module Git
     class FileAccess < Adapter

data/lib/gitolite/init.rb

@@ -1,3 +1,20 @@
+#
+# Copyright (C) 2010-2016 dtk contributors
+#
+# This file is part of the dtk project.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
 # use to require all needed files needed for running dtk-common gitolite lib
 require 'grit'; require 'erubis'