prestruct 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 0c23bc41f37cc64757d4d5fad96df37d4d81d552158db70d88ec4ed422917e30
+  data.tar.gz: 4f476b3858310e063c3a49f2897946c8b76e5ac51c8a78d7b8227a547f40e3f6
+SHA512:
+  metadata.gz: 7492eb6fc082734f22af276d70196f8a6b407e02216ac3594ab8cff8fbfda23334823dac9dfd5951d2c47520d24d9ed9bc94220fe2065cabadde003619273f97
+  data.tar.gz: 3726582dcbb0a65389bc89f1a8f43d69810f5db628494cb10434df62956d7bd1743e41cc420390db9ab7485f4a6cfa9f1051dc82bd48a3293da115b692e75261

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# 0.1.1 (January 13, 2023)
+  - Uploaded proper version of gem
+
+# 0.1.0 (January 13, 2023)
+
+## Initial release of gem:
+  - Release with ability to build file structure for single file and mvc Sinatra projects.

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Lokalise team, Ilya Bodrov
+
+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,33 @@
+# Prestruct: A Ruby gem that builds common project file structures for you
+
+Prestruct is a minimalist CLI ruby gem that creates the basic file structures for different formats of ruby projects.Currently only supports Sinatra single file and mvc projects. 
+
+*Mostly for expirementation and personal usage so the structuring is semi-opinionated.*
+
+**Installation**
+To install from the command line:
+```
+gem install prestruct
+```
+**Usage**
+Once installed, Prestruct can be used anywhere from the command line. Navigate to the directory you plan to place your project in then:
+```
+prestruct [Project type (sinatra)] [structure (simple, mvc)] [-n project_name]
+```
+After your preferred project type, input your preferred file structure. You can also specify a title for your project with `-n` or `--name`. If unspecified, the project name will default to `new_project`. 
+
+**Example Usage**
+```
+prestruct sinatra mvc -n word_analyzer  
+# creates a mvc sinatra project with the name 'word_analyzer'
+
+prestruct sinatra simple
+# creates a single file sinatra project with default name 'project_name'
+```
+
+**Additional Options**
+```
+-v, --version       # shows the current version of Prestruct installed
+-h, --help          # shows the argument structure that Prestruct accepts
+-n, --name          # used alongside a project type to specify a project name
+```

data/bin/prestruct

@@ -0,0 +1,35 @@
+#!/usr/bin/env ruby
+
+require 'prestruct'
+require 'slop'
+
+opts = Slop.parse do |o|
+  o.string 'sinatra', 'create sinatra project', suppress_errors: true
+  o.string '-n', '--name', 'project name', suppress_errors: true
+  o.on '-h', '--help' do
+    puts 'Usage: prestruct [sinatra mvc/simple] [-n project name]'
+    exit
+  end
+  o.on '-v', '--version' do
+    puts 'prestruct v0.1.0'
+    exit
+  end
+end
+
+args = opts.to_hash
+
+args[:name] ||= 'project_name'
+if args[:sinatra]
+  case args[:sinatra]
+  when "simple"
+    puts "prestructing..."
+    SinStruct::Base.new(args[:name])
+  when "mvc"
+    puts "prestructing..."
+    SinStruct::Mvc.new(args[:name])
+  else
+    puts "Please specify either 'simple' or 'mvc' after 'sinatra'"
+  end
+else
+  puts "Usage: prestruct [sinatra mvc/simple] [-n project_name]"
+end

data/lib/prestruct/contents.rb

@@ -0,0 +1,66 @@
+module FileContents
+  class << self
+    def css
+      ["styles.css", "css here"]
+    end
+  
+    def readme
+      ["README.MD", "Description and installation instructions for project here"]
+    end
+  end
+
+  module Sinatra
+    class << self
+      def gemfile
+        ["Gemfile", "source 'https://rubygems.org'"]
+      end
+  
+      def model
+        ["model.rb", "# data management classes and code here"]
+      end
+  
+      def view
+        contents = <<~FILE
+          <!--view content here-->
+        FILE
+        ["view.erb", contents]
+      end
+  
+      def layout
+        contents = <<~FILE
+          <!doctype html>
+          <html lang="en-US">
+            <head>
+              <title>Rec Analyzer</title>
+              <meta charset="UTF-8">
+              <link rel="stylesheet" type="text/css" href="<%= url('/stylesheets/styles.css') %>"> 
+            </head>
+            <body></body>
+          </html>
+        FILE
+        ['layout.erb', contents]
+      end
+  
+      def controller(project_name)
+        contents = <<~FILE
+          require 'sinatra'
+          # view controller
+          # routes go here
+        FILE
+        ["#{project_name}.rb", contents]
+      end
+  
+      def config
+        ["config.ru", "require 'route_to_controller'\nrun Sinatra::Application"]
+      end
+
+      def helpers
+        ["helpers.rb", "# helper methods go here"]
+      end
+
+      def spec(project_name)
+        ["#{project_name}_test.rb", "require 'route_to_controller'\n# tests for project go here"]
+      end
+    end
+  end
+end

data/lib/prestruct/folder.rb

@@ -0,0 +1,42 @@
+class Folder
+  attr_accessor :files, :folders
+  def initialize(name)
+    @path = name
+    @files = []
+    @folders = {}
+  end
+
+  def add_files(*files)
+    files.each do |file|
+      @files << {path: "#{@path}/#{file[0]}", contents: file[1]}
+    end
+  end
+
+  def add_folder(name)
+    # consider making splat argument and being able to add multiple folders
+    @folders[name.to_s] = Folder.new("#{@path}/#{name}")
+  end
+
+  def create
+    # create own directory
+    Dir.mkdir(@path)
+
+    # create all files within directory
+    @files.each { |file| rw_file(file[:path], file[:contents]) } unless @files.empty?
+
+    # for each folder in @folders, run create method
+    @folders.values.each { |folder| folder.create } unless @folders.empty?
+  end
+
+  def to_s
+    @path
+  end
+
+  private
+
+  def rw_file(root, contents = "")
+    File.open(root, "w+") do |f|
+      f.write contents
+    end
+  end
+end

data/lib/prestruct/sinstruct.rb

@@ -0,0 +1,91 @@
+require_relative 'folder.rb'
+require_relative 'contents.rb'
+
+module SinStruct
+  class Base
+    include FileContents
+    include FileContents::Sinatra
+  
+    # Considering making entire class class methods
+    def initialize(project_name)
+      @project_name = project_name
+      construct
+    end
+
+    private
+
+    def construct
+      # create folder object with name
+      @root = Folder.new(@project_name)
+      # create app dir > add all files to it
+      build_app
+      # create public dir > add all files
+      build_public
+      # add loose files to folder
+      build_loose_files
+      # create folder
+      @root.create
+    end
+
+    def build_app
+      @app = @root.add_folder("app")
+      @app.add_files(Sinatra.controller(@root))
+      build_views
+    end
+
+    def build_views
+      @views = @app.add_folder("views")
+      @views.add_files(Sinatra.view, Sinatra.layout)
+    end
+
+    def build_public
+      @public = @root.add_folder("public")
+      @public.add_files(FileContents.css)
+    end
+
+    def build_loose_files
+      @root.add_files(Sinatra.config, Sinatra.gemfile, FileContents.readme)
+    end
+  end
+
+  class Mvc < Base
+    def construct
+      @root = Folder.new(@project_name)
+      build_app
+      build_public
+      build_specs
+      build_loose_files
+      @root.create
+    end
+
+    private
+
+    def build_app
+      @app = @root.add_folder("app")
+      build_models
+      build_controller
+      build_views
+      build_helpers
+    end
+
+    def build_models
+      @models = @app.add_folder("models")
+      @models.add_files(Sinatra.model)
+    end
+
+    def build_controller
+      @controllers = @app.add_folder("controllers")
+      @controllers.add_files(Sinatra.controller(@root))
+    end
+
+    def build_helpers
+      @helpers = @app.add_folder("helpers")
+      @helpers.add_files(Sinatra.helpers)
+    end
+
+    def build_specs
+      @specs = @app.add_folder("specs")
+      @specs.add_files(Sinatra.spec(@root))
+    end
+  end
+end

data/lib/prestruct/version.rb

@@ -0,0 +1,3 @@
+module PreStruct
+  VERSION = '0.1.1'
+end

data/lib/prestruct.rb

@@ -0,0 +1,5 @@
+require_relative 'prestruct/sinstruct.rb'
+
+module PreStruct
+  include SinStruct
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: prestruct
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Tomas Palpallatoc
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 4.9.3
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Generates the (semi-opinianated) basic file structure for a ruby project
+  in users current directory. Currently only supports Sinatra projects.
+email:
+- tomasphn@gmail.com
+executables:
+- prestruct
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/prestruct
+- lib/prestruct.rb
+- lib/prestruct/contents.rb
+- lib/prestruct/folder.rb
+- lib/prestruct/sinstruct.rb
+- lib/prestruct/version.rb
+homepage: https://github.com/tomasphn/prestruct
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.23
+signing_key: 
+specification_version: 4
+summary: Builds basic file structure for a ruby project
+test_files: []