import octo state enums for clarity

Author: mschuchard

src/concourse.rs

@@ -5,20 +5,21 @@ use serde::{Deserialize, Serialize};
 
 use concourse_resource::IntoMetadataKV;
 use octocrab;
+use octocrab::models::IssueState;
 
 // standard concourse structs
 // check input and (vec seralized to list) output, out output
 #[derive(Eq, PartialEq, Serialize, Deserialize, Debug)]
 pub(super) struct Version {
-    state: octocrab::models::IssueState,
+    state: IssueState,
 }
 
 impl Version {
     /// Constructor
     /// ```
-    /// let version = Version::new(octocrab::models::IssueState::Closed);
+    /// let version = Version::new(IssueState::Closed);
     /// ```
-    pub(super) fn new(state: octocrab::models::IssueState) -> Self {
+    pub(super) fn new(state: IssueState) -> Self {
         Version { state }
     }
 }
@@ -40,7 +41,7 @@ pub(super) struct Source {
     // for skipping check during e.g. put+create
     skip_check: Option<bool>,
     // trigger on issue state open or closed
-    trigger: Option<octocrab::models::IssueState>,
+    trigger: Option<IssueState>,
 }
 
 impl Source {
@@ -78,10 +79,8 @@ impl Source {
         self.skip_check.unwrap_or(false)
     }
     // return unwrapped value with default closed for ease of use
-    pub(super) fn trigger(&self) -> octocrab::models::IssueState {
-        self.trigger
-            .clone()
-            .unwrap_or(octocrab::models::IssueState::Closed)
+    pub(super) fn trigger(&self) -> IssueState {
+        self.trigger.clone().unwrap_or(IssueState::Closed)
     }
 }
 
@@ -126,7 +125,7 @@ pub(super) struct OutMetadata {
     number: u64,
     url: String,
     title: String,
-    state: octocrab::models::IssueState,
+    state: IssueState,
     #[serde(skip_serializing_if = "Vec::is_empty")]
     labels: Vec<octocrab::models::Label>,
     #[serde(skip_serializing_if = "Vec::is_empty")]
@@ -144,7 +143,7 @@ impl OutMetadata {
     ///     5,
     ///     String::from("http://does.not.exist"),
     ///     String::from("some issue"),
-    ///     octocrab::models::IssueState::Open,
+    ///     IssueState::Open,
     ///     vec![],
     ///     vec![],
     ///     None,
@@ -157,7 +156,7 @@ impl OutMetadata {
         number: u64,
         url: impl Into<String>,
         title: String,
-        state: octocrab::models::IssueState,
+        state: IssueState,
         labels: Vec<octocrab::models::Label>,
         assignees: Vec<octocrab::models::Author>,
         milestone: Option<octocrab::models::Milestone>,

src/github_issue.rs

@@ -4,6 +4,8 @@
 use log;
 
 use octocrab;
+use octocrab::models::IssueState;
+use octocrab::params::State;
 
 // allowed operations for github issue interactions
 #[non_exhaustive]
@@ -28,27 +30,27 @@ impl From<Action> for String {
     }
 }
 
-// convert string to IssueState or params::State without trait implementations because not allowed (no impl Into<octocrab::models::IssueState> for &str)
-fn str_to_issue_state(param: &str) -> Result<octocrab::models::IssueState, &str> {
+// convert string to IssueState or params::State without trait implementations because not allowed (no impl Into<IssueState> for &str)
+fn str_to_issue_state(param: &str) -> Result<IssueState, &str> {
     match param {
-        "open" => Ok(octocrab::models::IssueState::Open),
-        "closed" => Ok(octocrab::models::IssueState::Closed),
+        "open" => Ok(IssueState::Open),
+        "closed" => Ok(IssueState::Closed),
         "all" => {
             log::warn!(
                 "all was specified for issue state, and this can only be utilized with issue filtering, and not updating"
             );
             log::warn!("the issue state will be reset to 'open'");
-            Ok(octocrab::models::IssueState::Open)
+            Ok(IssueState::Open)
         }
         &_ => Err("the issue state must be either open or closed"),
     }
 }
 
-fn str_to_params_state(param: &str) -> Result<octocrab::params::State, &str> {
+fn str_to_params_state(param: &str) -> Result<State, &str> {
     match param {
-        "open" => Ok(octocrab::params::State::Open),
-        "closed" => Ok(octocrab::params::State::Closed),
-        "all" => Ok(octocrab::params::State::All),
+        "open" => Ok(State::Open),
+        "closed" => Ok(State::Closed),
+        "all" => Ok(State::All),
         &_ => Err("the issue state must be either open, closed, or all"),
     }
 }
@@ -68,7 +70,7 @@ pub(super) struct Issue<'issue> {
     assignees: Option<Vec<String>>,
     // read and update
     number: Option<u64>,
-    // update octocrab::models::IssueState and list octocrab::params::State
+    // update IssueState and list State
     state: Option<&'issue str>,
     // create, list, and update
     milestone: Option<u64>,

src/main.rs

@@ -2,7 +2,7 @@ use env_logger;
 use log;
 
 use concourse_resource::*;
-use octocrab;
+use octocrab::models::IssueState;
 
 mod concourse;
 mod github_issue;
@@ -37,8 +37,8 @@ impl concourse_resource::Resource for GithubIssue {
                 "the check step will be skipped because 'skip_check' was set to true in source"
             );
             return vec![
-                concourse::Version::new(octocrab::models::IssueState::Open),
-                concourse::Version::new(octocrab::models::IssueState::Closed),
+                concourse::Version::new(IssueState::Open),
+                concourse::Version::new(IssueState::Closed),
             ];
         }
 
@@ -76,11 +76,11 @@ impl concourse_resource::Resource for GithubIssue {
         // return two sized version vector if issue state matches trigger, and one sized if otherwise
         if issue.state == source.trigger() {
             vec![
-                concourse::Version::new(octocrab::models::IssueState::Open),
-                concourse::Version::new(octocrab::models::IssueState::Closed),
+                concourse::Version::new(IssueState::Open),
+                concourse::Version::new(IssueState::Closed),
             ]
         } else {
-            vec![concourse::Version::new(octocrab::models::IssueState::Open)]
+            vec![concourse::Version::new(IssueState::Open)]
         }
     }
 
@@ -105,7 +105,7 @@ impl concourse_resource::Resource for GithubIssue {
             "there is no actual functionality for the in step, and the version and metadata are dummied"
         );
         Ok(concourse_resource::InOutput {
-            version: concourse::Version::new(octocrab::models::IssueState::Open),
+            version: concourse::Version::new(IssueState::Open),
             metadata: None,
         })
     }
@@ -177,7 +177,7 @@ impl concourse_resource::Resource for GithubIssue {
 
         // return out step output
         concourse_resource::OutOutput {
-            version: concourse::Version::new(octocrab::models::IssueState::Open),
+            version: concourse::Version::new(IssueState::Open),
             metadata: Some(concourse::OutMetadata::new(
                 issue.number,
                 issue.url,