activerse 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b3f87b8fda678a8ab7c759cede469f763fb274a32fb4175e5880c57dd5a727d7
+  data.tar.gz: db6972302af44ff6904b39487c4dffa8673c2bfb2796e9a01472a6448328bf44
+SHA512:
+  metadata.gz: 790f6fac64046ba696e21f1fe5cdb829393bf53ac491fae52234fb81a81ae7b688db6258b4aa98ba93b340a71dd9b3a3e7c0c9bcdf338a7db5788d9ccae59a4b
+  data.tar.gz: 3bb700d7ad6c5cd353562c6d462a447c3f88c68ef11decab45e4b264116ebb0f3f19efaef734cd9db975940b13a61b6f1356aa0ba12d3c016aa58c2dff6ed68f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Pietro Moro
+
+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,61 @@
+# WIP: Activerse
+[![Gem Version](https://badge.fury.io/rb/activerse.svg)](https://badge.fury.io/rb/activerse)
+[![Codacy Badge](https://api.codacy.com/project/badge/Grade/fe0e9c2138d24d10a268e72491562fec)](https://www.codacy.com/manual/pietromoro/activerse?utm_source=github.com&utm_medium=referral&utm_content=pietromoro/activerse&utm_campaign=Badge_Grade)
+
+This gem is currently in the process of being made.
+
+**DISCLAMER** All text is either temporary or not yet implemented. It is only a proposal of how the library could work
+
+<a href="https://www.buymeacoffee.com/pietromoro" target="_blank"><img src="https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png" alt="Buy Me A Coffee" style="height: 41px !important;width: 174px !important;box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;-webkit-box-shadow: 0px 3px 2px 0px rgba(190, 190, 190, 0.5) !important;" ></a>
+
+## Usage
+Run `rails generate activerse:install` to create the configuration file, as well as uncheking your `credentials.yml.enc` file from version control and adding it to the `.gitignore`. Then you can setup how you want your credentials file to look like in the initializer
+file `activerse.rb` like this:
+
+```ruby
+config.credentials do
+  section "Email configuration", :email do
+    set :port, to: ask("Port:")
+    set :email, to: ask("Email:")
+    set :pwd, to: ask("Auth Token:")
+  end
+end
+```
+See the wiki for more informations.
+
+In the `config/initializers/activese.rb` file you can specify more general settings.
+
+See the wiki or directly the initializer file for more configuration options.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'activerse'
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install activerse
+```
+
+To create all necessary setup and files run:
+```bash
+$ rails g activerse:install
+```
+
+When ready to fill your credentials run:
+```bash
+$ rails g activerse:fill
+```
+
+## Contributing
+Contributions will be welome when first few iterations will be going out.
+
+## License
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Activerse'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task default: :test

data/lib/activerse.rb

@@ -0,0 +1,7 @@
+require "activerse/railtie"
+require "activerse/version"
+require "activerse/configs"
+require "activerse/dsl"
+
+module Activerse
+end

data/lib/activerse/configs.rb

@@ -0,0 +1,18 @@
+module Activerse
+  module Configs
+    mattr_accessor :finalize_behaviour
+    @@finalize_behaviour = :restart_server
+
+    mattr_accessor :strip_whitespaces
+    @@strip_whitespaces = true
+
+    def self.setup
+      yield self
+    end
+
+    mattr_reader :internal_structure
+    def self.credentials(&block)
+      @@internal_structure = block
+    end
+  end
+end

data/lib/activerse/dsl.rb

@@ -0,0 +1,51 @@
+module Activerse
+  class Dsl
+    def initialize(hash = {})
+      @credentials = hash
+      @current_keys = []
+    end
+
+  private
+    def section title, sym = nil, &block
+      guess = `tput cols`.to_i
+      guess == 0 ? 80 : guess
+      puts " #{title.to_s} ".center(guess, '=')
+      @current_keys.push sym.nil? ? title.to_sym : sym.to_sym
+      instance_eval(&block)
+      @current_keys.pop
+      puts '-' * guess
+    end
+
+    def subsection name, &block
+      @current_keys.push name.to_sym
+      instance_eval(&block)
+      @current_keys.pop
+    end
+
+    def set key, to: nil
+      last = @current_keys.inject(@credentials) { |structure, key| structure[key] ||= {} }
+      last[key.to_sym] = to
+    end
+ 
+    def ask question, echo: true
+      print question + " "
+      if Activerse::Configs.strip_whitespaces
+        return gets.chomp.strip
+      else
+        return gets.chomp
+      end
+    end
+
+    def ask_and_set key, question, *args
+      last = @current_keys.inject(@credentials) { |structure, key| structure[key] ||= {} }
+      last_value = last[key.to_sym].nil? ? "" : last[key.to_sym]
+      response = ask("#{question} (#{last_value})", *args)
+      last[key.to_sym] = response.blank? ? last_value : response
+    end
+
+    def save_to_database model, *args
+      model.create!(*args)
+      set model.to_sym, to: true
+    end
+  end
+end

data/lib/activerse/railtie.rb

@@ -0,0 +1,4 @@
+module Activerse
+  class Railtie < ::Rails::Railtie
+  end
+end

data/lib/activerse/version.rb

@@ -0,0 +1,3 @@
+module Activerse
+  VERSION = '1.0.0'
+end

data/lib/generators/activerse/fill_generator.rb

@@ -0,0 +1,17 @@
+require 'rails/generators/base'
+
+module Activerse
+  module Generators
+    class FillGenerator < ::Rails::Generators::Base
+      desc "Fill out the credentials file and run startup code"
+
+      def fill_out
+        current_credentials = YAML.load(Rails.application.credentials.read)
+        current_credentials.symbolize_keys!
+        dsl = Activerse::Dsl.new(current_credentials)
+        dsl.instance_eval(&Activerse::Configs.internal_structure)
+        Rails.application.credentials.write YAML.dump(dsl.instance_eval("@credentials"))
+      end
+    end
+  end
+end

data/lib/generators/activerse/install_generator.rb

@@ -0,0 +1,54 @@
+require 'rails/generators/base'
+
+module Activerse
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+
+      desc "Initialize activerse (creates the initializer file)"
+
+      def copy_templates
+        template "activerse.rb", "config/initializers/activerse.rb"
+      end
+
+      def ensure_credentials_files
+        key_path = Rails.application.config.credentials.key_path
+        credentials_path = Rails.application.config.credentials.content_path
+        encryption_key_file_generator.add_key_file(key_path) unless File.exists? key_path
+        credentials_generator.add_credentials_file_silently unless File.exists? credentials_path
+      end
+
+      def update_git
+        return unless Dir.exists? ".git"
+        if File.exists? "config/credentials.enc.yml"
+          git rm: "--cached config/credentials.enc.yml"
+        end
+
+        append_to_file ".gitignore", <<-GIT
+        # Ignore credentials file (Activerse)
+        config/master.key
+        config/credentials.enc.yml
+        GIT
+      end
+
+      def show_readme
+        readme "README" if behavior == :invoke
+      end
+    
+    private
+      def encryption_key_file_generator
+        require "rails/generators"
+        require "rails/generators/rails/encryption_key_file/encryption_key_file_generator"
+
+        Rails::Generators::EncryptionKeyFileGenerator.new
+      end
+
+      def credentials_generator
+        require "rails/generators"
+        require "rails/generators/rails/credentials/credentials_generator"
+
+        Rails::Generators::CredentialsGenerator.new
+      end
+    end
+  end
+end

data/lib/generators/templates/README

@@ -0,0 +1,27 @@
+===========================================================
+
+Activerse installed.
+Remember to use the initializer file to create your
+desired credentials structure. You may run
+
+  rails g activerse:fill
+
+to fill out your credentials file. Addition made into the
+initializer will reflect on the credentials file upon
+reissuing this command.
+
+
+You may want to regenerate your master key with
+
+  rake activerse:regenkeys
+
+or generate fresh credentials with
+
+  EDITOR="vim" rails credentials:edit
+
+
+Remember that either your config/credentials.yml.enc
+and your config/master.key files *must not* be under
+source control.
+
+===========================================================

data/lib/generators/templates/activerse.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+# This is the configuration file for activerse.
+# In here you can customize some general configuration
+# options as well as per page actions.
+Activerse::Configs.setup do |config|
+
+  # Block that will be called in the context of a controller
+  # before finalize_behaviour gets called and after all
+  # credentials have been configured.
+  # config.on_finalize
+  #   # your code here
+  # end
+
+  # The behaviour that activerse should use when all
+  # configurations have been set up.
+  # Possible values are :reload_routes, :restart_server.
+  config.finalize_behaviour = :restart_server
+
+  # Strip whitespaces from entered values.
+  config.strip_whitespaces = true
+
+  # Configure the structure of the credentials file
+  # with the custom DLS.
+  config.credentials do
+    # code here
+  end
+end

data/lib/tasks/activerse_tasks.rake

@@ -0,0 +1,6 @@
+namespace :activerse do
+  desc "Regenerate config/master.key or generate a new one"
+  task :regenkeys do
+    # code
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: activerse
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Pietro Moro
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.0.1
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+description: Rails gem that allows a project to be distributed over multiple companies,
+  without having to set specific credentials in a file, allowing to distribute only
+  it's structure with a web ui.
+email:
+- pietromoro@programmer.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/activerse.rb
+- lib/activerse/configs.rb
+- lib/activerse/dsl.rb
+- lib/activerse/railtie.rb
+- lib/activerse/version.rb
+- lib/generators/activerse/fill_generator.rb
+- lib/generators/activerse/install_generator.rb
+- lib/generators/templates/README
+- lib/generators/templates/activerse.rb
+- lib/tasks/activerse_tasks.rake
+homepage: https://github.com/pietromoro/activerse
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key: 
+specification_version: 4
+summary: Generate initial settings and configurations with a web interface.
+test_files: []